Skip to content

Latest commit

 

History

History
116 lines (87 loc) · 1.76 KB

README.md

File metadata and controls

116 lines (87 loc) · 1.76 KB

May the schwartz be with you!

sCHwARTz - Character Art

Installation

Install with bower bower install schwartz.js

API spec

Constructor

Schwartz new Schwartz(
    [Object options]
)

Options

options.inverse

Type: Boolean Default: False

Inverse image

options.detail

Type: Nubmer Default: 50

Depth of detail

options.render

Type: Function

Output callback

Generate character art from image source

void generateFromImage(
    String src
)

Generate character art from video

void generateFromVideo(
    DOMElement video
)

Set up depth of detail

void setDetail(
    Number n
)

Set up characters

void setCharSet(
    String str
)

Inverse image

void inverseImage()

##Usage Examples

Generate from image

var
    body    = document.getElementsByTagName('body')[0],

    render = function() {
        //
    },

    schwartz = new Schwartz({
        render: render,
        detail: 60
    });
// end of vars

schwartz.generateFromImage('/path/to/img.jpg');

Generate from video

var
    body    = document.getElementsByTagName('body')[0],
    video   = document.getElementsByTagName('video')[0],

    render = function() {
        //
    },

    schwartz = new Schwartz({
        render: render,
        inverse: true,
        detail: 50
    });
// end of vars

schwartz.generateFromVideo(video);

License

Copyright (c) 2014 Alexandr Zaytcev. Licensed under the MIT license.