├── .gitignore
├── .npmignore
├── Gruntfile.js
├── README.md
├── build
├── kami.js
└── kami.min.js
├── demos
└── build
│ ├── bundle.js
│ └── kami.min.js
├── docs
├── api.js
├── assets
│ ├── css
│ │ ├── external-small.png
│ │ ├── logo.png
│ │ └── main.css
│ ├── favicon.png
│ ├── img
│ │ └── spinner.gif
│ ├── index.html
│ ├── js
│ │ ├── api-filter.js
│ │ ├── api-list.js
│ │ ├── api-search.js
│ │ ├── apidocs.js
│ │ └── yui-prettify.js
│ └── vendor
│ │ └── prettify
│ │ ├── CHANGES.html
│ │ ├── COPYING
│ │ ├── README.html
│ │ ├── prettify-min.css
│ │ └── prettify-min.js
├── classes
│ ├── BaseBatch.html
│ ├── FrameBuffer.html
│ ├── Mesh.html
│ ├── ShaderProgram.html
│ ├── SpriteBatch.html
│ ├── Texture.html
│ ├── WebGLContext.html
│ └── index.html
├── data.json
├── files
│ ├── index.html
│ ├── lib_BaseBatch.js.html
│ ├── lib_SpriteBatch.js.html
│ ├── lib_Texture.js.html
│ ├── lib_TextureRegion.js.html
│ ├── lib_WebGLContext.js.html
│ ├── lib_glutils_FrameBuffer.js.html
│ ├── lib_glutils_Mesh.js.html
│ ├── lib_glutils_ShaderProgram.js.html
│ ├── lib_index-umd.js.html
│ └── lib_index.js.html
├── index.html
└── modules
│ ├── index.html
│ └── kami.html
├── lib
├── BaseBatch.js
├── SpriteBatch.js
├── Texture.js
├── TextureRegion.js
├── WebGLContext.js
├── glutils
│ ├── FrameBuffer.js
│ ├── Mesh.js
│ └── ShaderProgram.js
├── index-umd.js
└── index.js
└── package.json
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | bower_components
3 | .DS_Store
4 | npm-debug.log
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | bower_components
3 | .DS_Store
4 | build/
5 | demos/
6 | Gruntfile.js
7 | docs/
--------------------------------------------------------------------------------
/Gruntfile.js:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | module.exports = function(grunt) {
5 |
6 | require('load-grunt-tasks')(grunt);
7 |
8 | grunt.initConfig({
9 |
10 | pkg: grunt.file.readJSON('package.json'),
11 |
12 | dirs: {
13 | build: 'build',
14 | src: 'lib',
15 | demos: 'demos',
16 | demo_src: 'demos/src',
17 | demo_build: 'demos/build',
18 | docs: 'docs'
19 | },
20 |
21 | browserify: {
22 | //We include a UMD build for non-Node people...
23 | umd: {
24 | src: ['<%= dirs.src %>/index-umd.js'],
25 | dest: '<%= dirs.build %>/kami.js',
26 |
27 | options: {
28 | standalone: "kami",
29 | debug: true
30 | }
31 | },
32 |
33 | demos: {
34 | src: ['<%= dirs.src %>/index.js'],
35 | dest: '<%= dirs.demo_build %>/bundle.js',
36 |
37 | options: {
38 | debug: true,
39 | alias: [
40 | '<%= dirs.src %>/index.js:kami',
41 | 'signals', //externalize,
42 | 'number-util'
43 | ]
44 | }
45 | }
46 | },
47 |
48 | watch: {
49 | demos: {
50 | //Watch for changes...
51 | files: ['<%= dirs.src %>/**/*.js',
52 | '<%= dirs.demo_src %>/**/*.js',
53 | '<%= dirs.demos %>/**/*.html',
54 | 'Gruntfile.js'],
55 | tasks: ['browserify:demos', 'yuidoc'],
56 | options: {
57 | livereload: true
58 | },
59 | },
60 | },
61 |
62 |
63 | uglify: {
64 | umd: {
65 | files: {
66 | '<%= dirs.build %>/kami.min.js': ['<%= dirs.build %>/kami.js']
67 | }
68 | },
69 | demos: {
70 | files: {
71 | '<%= dirs.demo_build %>/kami.min.js': ['<%= dirs.build %>/kami.js']
72 | }
73 | }
74 | },
75 |
76 | //Builds the documentation; do not run this task directly
77 | yuidoc: {
78 | compile: {
79 | name: '<%= pkg.name %>',
80 | description: '<%= pkg.description %>',
81 | version: '<%= pkg.version %>',
82 | url: '<%= pkg.homepage %>',
83 | options: {
84 | paths: '<%= dirs.src %>',
85 | outdir: '<%= dirs.docs %>',
86 |
87 | //nocode: true,
88 | }
89 | }
90 | },
91 |
92 | //We use a little grunt plugin to write out the index.js file.
93 | //This also builds a UMD-specific index file, which is then browserified.
94 | autoindex: {
95 | umd: {
96 | options: {
97 | banner: "/**\n" +
98 | " Auto-generated Kami index file.\n" +
99 | " Dependencies are placed on the top-level namespace, for convenience.\n" +
100 | " Created on <%= grunt.template.today('yyyy-mm-dd') %>.\n" +
101 | "*/",
102 |
103 | // Options for our dependency modules...
104 | modules: {
105 |
106 | //Export this module with the name 'Class'
107 | 'klasse': {
108 | standalone: 'Class'
109 | },
110 |
111 | //We want to export the NumberUtils too..
112 | //we'll use the same naming style as the rest of Kami
113 | 'number-util': {
114 | standalone: 'NumberUtil'
115 | }
116 | }
117 | },
118 | dest: '<%= dirs.src %>/index-umd.js',
119 | src: '<%= dirs.src %>'
120 | },
121 |
122 | core: {
123 | options: {
124 | banner: "/**\n" +
125 | " Auto-generated Kami index file.\n" +
126 | " Created on <%= grunt.template.today('yyyy-mm-dd') %>.\n" +
127 | "*/",
128 |
129 | // only core modules
130 | dependencies: [],
131 | // ignore the UMD file if it's present
132 | file_ignores: ['<%= dirs.src %>/index-umd.js'],
133 | },
134 | dest: '<%= dirs.src %>/index.js',
135 | src: '<%= dirs.src %>'
136 | }
137 | }
138 | });
139 |
140 | //Builds core library
141 | grunt.registerTask('build-umd', ['autoindex:umd', 'browserify:umd', 'uglify:umd']);
142 |
143 | //Depends on build-umd
144 | grunt.registerTask('build-demos', ['browserify:demos', 'uglify:demos'])
145 |
146 |
147 | grunt.registerTask('build', ['autoindex:core', 'build-umd', 'build-demos', 'yuidoc']);
148 | grunt.registerTask('default', ['build']);
149 |
150 | };
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## Upcoming v1.0.0 Changes
2 |
3 | Kami is now breaking into small and composable modules that will be published separately to NPM. Most new work is under the [stackgl](https://github.com/stackgl) ecosystem. However, some higher-level 2D game abstractions may be eventually built on top of these modules under the kami namespace.
4 |
5 | ## kami
6 |
7 | Kami is a fast and lightweight WebGL sprite rendering framework.
8 |
9 | It is ideal for tinkering with WebGL, building your game engine on top of, or writing applications that require low-level control over vertex data, textures, and so forth.
10 |
11 | **This library is still in development.**
12 |
13 | ## Docs
14 |
15 | [Kami API Docs](http://mattdesl.github.io/kami/docs/)
16 |
17 | ## Usage
18 |
19 | Here is an example using Node style requires and browserify:
20 |
21 | ```javascript
22 | //require the necessary classes from the 'kami' module
23 | var AssetManager = require('kami').AssetManager;
24 | var SpriteBatch = require('kami').SpriteBatch;
25 |
26 | var WebGLContext = require('kami').WebGLContext;
27 |
28 | var width = 256;
29 | var height = 256;
30 |
31 | //create our webGL context..
32 | //this will manage viewport and context loss/restore
33 | var context = new WebGLContext(width, height);
34 |
35 | //add the GL canvas to the DOM
36 | document.body.appendChild(context.view);
37 |
38 | //Create a new batcher for 2D sprites
39 | var batch = new SpriteBatch(context);
40 |
41 | //Create a new texture. This will load the URL asynchronously
42 | var tex0 = new Texture(context, "img/mysprite.png");
43 |
44 | //kami aliases some Texture GLenums for convenience
45 | tex0.setFilter(Texture.Filter.LINEAR);
46 |
47 | //Start our render loop
48 | requestAnimationFrame(render);
49 |
50 | function render() {
51 | requestAnimationFrame(render);
52 |
53 | var gl = context.gl;
54 |
55 | //clear the GL canvas
56 | gl.clear(gl.COLOR_BUFFER_BIT);
57 |
58 | //start the batch...
59 | batch.begin();
60 |
61 | //draw the texture at (75, 75) with a size of 100x100
62 | batch.draw(tex0, 75, 75, 100, 100);
63 |
64 | //draw it some other places
65 | batch.draw(tex0, 0, 0, 15, 25);
66 | batch.draw(tex0, 100, 100);
67 |
68 | //flush sprites to GPU
69 | batch.end();
70 | }
71 | ```
72 |
73 | ## demos
74 |
75 | The demos are hosted in another package, see here:
76 | https://github.com/mattdesl/kami-demos
77 |
78 | ## Using without Node
79 |
80 | If you aren't using Node and `require()` statements, you can grab the UMD build at `build/kami.js`.
81 |
82 | Most of the code looks exactly the same, except all of Kami's objects are exported onto a global `kami` namespace. The dependencies are also exported on the namespace, for convenience. See here:
83 |
84 | ```html
85 |
86 |
99 | ```
100 |
101 | ## Road Map / TODOs
102 |
103 | - WebGL2 utils: compressed textures (done, see kami-demos), texture arrays, float textures, instanced draws, etc.
104 | - Cube maps and other Texture utils
105 | - clean up asset loading and kami-assets
106 | - MRTs for FrameBuffer utility (WebGL2)
107 | - SpriteBatch should use matrices (projeciton/transform)
108 | - SpriteBatch needs rotation
--------------------------------------------------------------------------------
/docs/api.js:
--------------------------------------------------------------------------------
1 | YUI.add("yuidoc-meta", function(Y) {
2 | Y.YUIDoc = { meta: {
3 | "classes": [
4 | "BaseBatch",
5 | "FrameBuffer",
6 | "Mesh",
7 | "ShaderProgram",
8 | "SpriteBatch",
9 | "Texture",
10 | "WebGLContext"
11 | ],
12 | "modules": [
13 | "kami"
14 | ],
15 | "allModules": [
16 | {
17 | "displayName": "kami",
18 | "name": "kami"
19 | }
20 | ]
21 | } };
22 | });
--------------------------------------------------------------------------------
/docs/assets/css/external-small.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mattdesl/kami/9a429563a4a2939f8aa4ff44abeb5330f74fe573/docs/assets/css/external-small.png
--------------------------------------------------------------------------------
/docs/assets/css/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mattdesl/kami/9a429563a4a2939f8aa4ff44abeb5330f74fe573/docs/assets/css/logo.png
--------------------------------------------------------------------------------
/docs/assets/favicon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mattdesl/kami/9a429563a4a2939f8aa4ff44abeb5330f74fe573/docs/assets/favicon.png
--------------------------------------------------------------------------------
/docs/assets/img/spinner.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mattdesl/kami/9a429563a4a2939f8aa4ff44abeb5330f74fe573/docs/assets/img/spinner.gif
--------------------------------------------------------------------------------
/docs/assets/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Redirector
5 | Click here to redirect
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/assets/js/api-filter.js:
--------------------------------------------------------------------------------
1 | YUI.add('api-filter', function (Y) {
2 |
3 | Y.APIFilter = Y.Base.create('apiFilter', Y.Base, [Y.AutoCompleteBase], {
4 | // -- Initializer ----------------------------------------------------------
5 | initializer: function () {
6 | this._bindUIACBase();
7 | this._syncUIACBase();
8 | },
9 | getDisplayName: function(name) {
10 |
11 | Y.each(Y.YUIDoc.meta.allModules, function(i) {
12 | if (i.name === name && i.displayName) {
13 | name = i.displayName;
14 | }
15 | });
16 |
17 | return name;
18 | }
19 |
20 | }, {
21 | // -- Attributes -----------------------------------------------------------
22 | ATTRS: {
23 | resultHighlighter: {
24 | value: 'phraseMatch'
25 | },
26 |
27 | // May be set to "classes" or "modules".
28 | queryType: {
29 | value: 'classes'
30 | },
31 |
32 | source: {
33 | valueFn: function() {
34 | var self = this;
35 | return function(q) {
36 | var data = Y.YUIDoc.meta[self.get('queryType')],
37 | out = [];
38 | Y.each(data, function(v) {
39 | if (v.toLowerCase().indexOf(q.toLowerCase()) > -1) {
40 | out.push(v);
41 | }
42 | });
43 | return out;
44 | };
45 | }
46 | }
47 | }
48 | });
49 |
50 | }, '3.4.0', {requires: [
51 | 'autocomplete-base', 'autocomplete-highlighters', 'autocomplete-sources'
52 | ]});
53 |
--------------------------------------------------------------------------------
/docs/assets/js/api-list.js:
--------------------------------------------------------------------------------
1 | YUI.add('api-list', function (Y) {
2 |
3 | var Lang = Y.Lang,
4 | YArray = Y.Array,
5 |
6 | APIList = Y.namespace('APIList'),
7 |
8 | classesNode = Y.one('#api-classes'),
9 | inputNode = Y.one('#api-filter'),
10 | modulesNode = Y.one('#api-modules'),
11 | tabviewNode = Y.one('#api-tabview'),
12 |
13 | tabs = APIList.tabs = {},
14 |
15 | filter = APIList.filter = new Y.APIFilter({
16 | inputNode : inputNode,
17 | maxResults: 1000,
18 |
19 | on: {
20 | results: onFilterResults
21 | }
22 | }),
23 |
24 | search = APIList.search = new Y.APISearch({
25 | inputNode : inputNode,
26 | maxResults: 100,
27 |
28 | on: {
29 | clear : onSearchClear,
30 | results: onSearchResults
31 | }
32 | }),
33 |
34 | tabview = APIList.tabview = new Y.TabView({
35 | srcNode : tabviewNode,
36 | panelNode: '#api-tabview-panel',
37 | render : true,
38 |
39 | on: {
40 | selectionChange: onTabSelectionChange
41 | }
42 | }),
43 |
44 | focusManager = APIList.focusManager = tabviewNode.plug(Y.Plugin.NodeFocusManager, {
45 | circular : true,
46 | descendants: '#api-filter, .yui3-tab-panel-selected .api-list-item a, .yui3-tab-panel-selected .result a',
47 | keys : {next: 'down:40', previous: 'down:38'}
48 | }).focusManager,
49 |
50 | LIST_ITEM_TEMPLATE =
51 | '' +
52 | '{displayName} ' +
53 | ' ';
54 |
55 | // -- Init ---------------------------------------------------------------------
56 |
57 | // Duckpunch FocusManager's key event handling to prevent it from handling key
58 | // events when a modifier is pressed.
59 | Y.before(function (e, activeDescendant) {
60 | if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) {
61 | return new Y.Do.Prevent();
62 | }
63 | }, focusManager, '_focusPrevious', focusManager);
64 |
65 | Y.before(function (e, activeDescendant) {
66 | if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) {
67 | return new Y.Do.Prevent();
68 | }
69 | }, focusManager, '_focusNext', focusManager);
70 |
71 | // Create a mapping of tabs in the tabview so we can refer to them easily later.
72 | tabview.each(function (tab, index) {
73 | var name = tab.get('label').toLowerCase();
74 |
75 | tabs[name] = {
76 | index: index,
77 | name : name,
78 | tab : tab
79 | };
80 | });
81 |
82 | // Switch tabs on Ctrl/Cmd-Left/Right arrows.
83 | tabviewNode.on('key', onTabSwitchKey, 'down:37,39');
84 |
85 | // Focus the filter input when the `/` key is pressed.
86 | Y.one(Y.config.doc).on('key', onSearchKey, 'down:83');
87 |
88 | // Keep the Focus Manager up to date.
89 | inputNode.on('focus', function () {
90 | focusManager.set('activeDescendant', inputNode);
91 | });
92 |
93 | // Update all tabview links to resolved URLs.
94 | tabview.get('panelNode').all('a').each(function (link) {
95 | link.setAttribute('href', link.get('href'));
96 | });
97 |
98 | // -- Private Functions --------------------------------------------------------
99 | function getFilterResultNode() {
100 | return filter.get('queryType') === 'classes' ? classesNode : modulesNode;
101 | }
102 |
103 | // -- Event Handlers -----------------------------------------------------------
104 | function onFilterResults(e) {
105 | var frag = Y.one(Y.config.doc.createDocumentFragment()),
106 | resultNode = getFilterResultNode(),
107 | typePlural = filter.get('queryType'),
108 | typeSingular = typePlural === 'classes' ? 'class' : 'module';
109 |
110 | if (e.results.length) {
111 | YArray.each(e.results, function (result) {
112 | frag.append(Lang.sub(LIST_ITEM_TEMPLATE, {
113 | rootPath : APIList.rootPath,
114 | displayName : filter.getDisplayName(result.highlighted),
115 | name : result.text,
116 | typePlural : typePlural,
117 | typeSingular: typeSingular
118 | }));
119 | });
120 | } else {
121 | frag.append(
122 | '' +
123 | 'No ' + typePlural + ' found.' +
124 | ' '
125 | );
126 | }
127 |
128 | resultNode.empty(true);
129 | resultNode.append(frag);
130 |
131 | focusManager.refresh();
132 | }
133 |
134 | function onSearchClear(e) {
135 |
136 | focusManager.refresh();
137 | }
138 |
139 | function onSearchKey(e) {
140 | var target = e.target;
141 |
142 | if (target.test('input,select,textarea')
143 | || target.get('isContentEditable')) {
144 | return;
145 | }
146 |
147 | e.preventDefault();
148 |
149 | inputNode.focus();
150 | focusManager.refresh();
151 | }
152 |
153 | function onSearchResults(e) {
154 | var frag = Y.one(Y.config.doc.createDocumentFragment());
155 |
156 | if (e.results.length) {
157 | YArray.each(e.results, function (result) {
158 | frag.append(result.display);
159 | });
160 | } else {
161 | frag.append(
162 | '' +
163 | 'No results found. Maybe you\'ll have better luck with a ' +
164 | 'different query?' +
165 | ' '
166 | );
167 | }
168 |
169 |
170 | focusManager.refresh();
171 | }
172 |
173 | function onTabSelectionChange(e) {
174 | var tab = e.newVal,
175 | name = tab.get('label').toLowerCase();
176 |
177 | tabs.selected = {
178 | index: tab.get('index'),
179 | name : name,
180 | tab : tab
181 | };
182 |
183 | switch (name) {
184 | case 'classes': // fallthru
185 | case 'modules':
186 | filter.setAttrs({
187 | minQueryLength: 0,
188 | queryType : name
189 | });
190 |
191 | search.set('minQueryLength', -1);
192 |
193 | // Only send a request if this isn't the initially-selected tab.
194 | if (e.prevVal) {
195 | filter.sendRequest(filter.get('value'));
196 | }
197 | break;
198 |
199 | case 'everything':
200 | filter.set('minQueryLength', -1);
201 | search.set('minQueryLength', 1);
202 |
203 | if (search.get('value')) {
204 | search.sendRequest(search.get('value'));
205 | } else {
206 | inputNode.focus();
207 | }
208 | break;
209 |
210 | default:
211 | // WTF? We shouldn't be here!
212 | filter.set('minQueryLength', -1);
213 | search.set('minQueryLength', -1);
214 | }
215 |
216 | if (focusManager) {
217 | setTimeout(function () {
218 | focusManager.refresh();
219 | }, 1);
220 | }
221 | }
222 |
223 | function onTabSwitchKey(e) {
224 | var currentTabIndex = tabs.selected.index;
225 |
226 | if (!(e.ctrlKey || e.metaKey)) {
227 | return;
228 | }
229 |
230 | e.preventDefault();
231 |
232 | switch (e.keyCode) {
233 | case 37: // left arrow
234 | if (currentTabIndex > 0) {
235 | tabview.selectChild(currentTabIndex - 1);
236 | inputNode.focus();
237 | }
238 | break;
239 |
240 | case 39: // right arrow
241 | if (currentTabIndex < (Y.Object.size(tabs) - 2)) {
242 | tabview.selectChild(currentTabIndex + 1);
243 | inputNode.focus();
244 | }
245 | break;
246 | }
247 | }
248 |
249 | }, '3.4.0', {requires: [
250 | 'api-filter', 'api-search', 'event-key', 'node-focusmanager', 'tabview'
251 | ]});
252 |
--------------------------------------------------------------------------------
/docs/assets/js/api-search.js:
--------------------------------------------------------------------------------
1 | YUI.add('api-search', function (Y) {
2 |
3 | var Lang = Y.Lang,
4 | Node = Y.Node,
5 | YArray = Y.Array;
6 |
7 | Y.APISearch = Y.Base.create('apiSearch', Y.Base, [Y.AutoCompleteBase], {
8 | // -- Public Properties ----------------------------------------------------
9 | RESULT_TEMPLATE:
10 | '' +
11 | '' +
12 | '{name} ' +
13 | '{resultType} ' +
14 | '{description}
' +
15 | '{class} ' +
16 | ' ' +
17 | ' ',
18 |
19 | // -- Initializer ----------------------------------------------------------
20 | initializer: function () {
21 | this._bindUIACBase();
22 | this._syncUIACBase();
23 | },
24 |
25 | // -- Protected Methods ----------------------------------------------------
26 | _apiResultFilter: function (query, results) {
27 | // Filter components out of the results.
28 | return YArray.filter(results, function (result) {
29 | return result.raw.resultType === 'component' ? false : result;
30 | });
31 | },
32 |
33 | _apiResultFormatter: function (query, results) {
34 | return YArray.map(results, function (result) {
35 | var raw = Y.merge(result.raw), // create a copy
36 | desc = raw.description || '';
37 |
38 | // Convert description to text and truncate it if necessary.
39 | desc = Node.create('' + desc + '
').get('text');
40 |
41 | if (desc.length > 65) {
42 | desc = Y.Escape.html(desc.substr(0, 65)) + ' …';
43 | } else {
44 | desc = Y.Escape.html(desc);
45 | }
46 |
47 | raw['class'] || (raw['class'] = '');
48 | raw.description = desc;
49 |
50 | // Use the highlighted result name.
51 | raw.name = result.highlighted;
52 |
53 | return Lang.sub(this.RESULT_TEMPLATE, raw);
54 | }, this);
55 | },
56 |
57 | _apiTextLocator: function (result) {
58 | return result.displayName || result.name;
59 | }
60 | }, {
61 | // -- Attributes -----------------------------------------------------------
62 | ATTRS: {
63 | resultFormatter: {
64 | valueFn: function () {
65 | return this._apiResultFormatter;
66 | }
67 | },
68 |
69 | resultFilters: {
70 | valueFn: function () {
71 | return this._apiResultFilter;
72 | }
73 | },
74 |
75 | resultHighlighter: {
76 | value: 'phraseMatch'
77 | },
78 |
79 | resultListLocator: {
80 | value: 'data.results'
81 | },
82 |
83 | resultTextLocator: {
84 | valueFn: function () {
85 | return this._apiTextLocator;
86 | }
87 | },
88 |
89 | source: {
90 | value: '/api/v1/search?q={query}&count={maxResults}'
91 | }
92 | }
93 | });
94 |
95 | }, '3.4.0', {requires: [
96 | 'autocomplete-base', 'autocomplete-highlighters', 'autocomplete-sources',
97 | 'escape'
98 | ]});
99 |
--------------------------------------------------------------------------------
/docs/assets/js/apidocs.js:
--------------------------------------------------------------------------------
1 | YUI().use(
2 | 'yuidoc-meta',
3 | 'api-list', 'history-hash', 'node-screen', 'node-style', 'pjax',
4 | function (Y) {
5 |
6 | var win = Y.config.win,
7 | localStorage = win.localStorage,
8 |
9 | bdNode = Y.one('#bd'),
10 |
11 | pjax,
12 | defaultRoute,
13 |
14 | classTabView,
15 | selectedTab;
16 |
17 | // Kill pjax functionality unless serving over HTTP.
18 | if (!Y.getLocation().protocol.match(/^https?\:/)) {
19 | Y.Router.html5 = false;
20 | }
21 |
22 | // Create the default route with middleware which enables syntax highlighting
23 | // on the loaded content.
24 | defaultRoute = Y.Pjax.defaultRoute.concat(function (req, res, next) {
25 | prettyPrint();
26 | bdNode.removeClass('loading');
27 |
28 | next();
29 | });
30 |
31 | pjax = new Y.Pjax({
32 | container : '#docs-main',
33 | contentSelector: '#docs-main > .content',
34 | linkSelector : '#bd a',
35 | titleSelector : '#xhr-title',
36 |
37 | navigateOnHash: true,
38 | root : '/',
39 | routes : [
40 | // -- / ----------------------------------------------------------------
41 | {
42 | path : '/(index.html)?',
43 | callbacks: defaultRoute
44 | },
45 |
46 | // -- /classes/* -------------------------------------------------------
47 | {
48 | path : '/classes/:class.html*',
49 | callbacks: [defaultRoute, 'handleClasses']
50 | },
51 |
52 | // -- /files/* ---------------------------------------------------------
53 | {
54 | path : '/files/*file',
55 | callbacks: [defaultRoute, 'handleFiles']
56 | },
57 |
58 | // -- /modules/* -------------------------------------------------------
59 | {
60 | path : '/modules/:module.html*',
61 | callbacks: defaultRoute
62 | }
63 | ]
64 | });
65 |
66 | // -- Utility Functions --------------------------------------------------------
67 |
68 | pjax.checkVisibility = function (tab) {
69 | tab || (tab = selectedTab);
70 |
71 | if (!tab) { return; }
72 |
73 | var panelNode = tab.get('panelNode'),
74 | visibleItems;
75 |
76 | // If no items are visible in the tab panel due to the current visibility
77 | // settings, display a message to that effect.
78 | visibleItems = panelNode.all('.item,.index-item').some(function (itemNode) {
79 | if (itemNode.getComputedStyle('display') !== 'none') {
80 | return true;
81 | }
82 | });
83 |
84 | panelNode.all('.no-visible-items').remove();
85 |
86 | if (!visibleItems) {
87 | if (Y.one('#index .index-item')) {
88 | panelNode.append(
89 | '' +
90 | '
' +
91 | 'Some items are not shown due to the current visibility ' +
92 | 'settings. Use the checkboxes at the upper right of this ' +
93 | 'page to change the visibility settings.' +
94 | '
' +
95 | '
' +
100 | '
' +
101 | 'This class doesn\'t provide any methods, properties, ' +
102 | 'attributes, or events.' +
103 | '
' +
104 | '
Change Log
5 |
6 |
7 | README
8 |
9 | Known Issues
10 |
11 | Perl formatting is really crappy. Partly because the author is lazy and
12 | partly because Perl is
13 | hard to parse.
14 | On some browsers, <code> elements with newlines in the text
15 | which use CSS to specify white-space:pre will have the newlines
16 | improperly stripped if the element is not attached to the document at the time
17 | the stripping is done. Also, on IE 6, all newlines will be stripped from
18 | <code> elements because of the way IE6 produces
19 | innerHTML. Workaround: use <pre> for code with
20 | newlines.
21 |
22 |
23 | Change Log
24 | 29 March 2007
25 |
26 | Added tests for PHP support
27 | to address
28 | issue 3 .
30 | Fixed
31 | bug : prettyPrintOne was not halting. This was not
33 | reachable through the normal entry point.
34 | Fixed
35 | bug : recursing into a script block or PHP tag that was not properly
37 | closed would not silently drop the content.
38 | (test )
39 | Fixed
40 | bug : was eating tabs
42 | (test )
43 | Fixed entity handling so that the caveat
44 |
45 | Caveats: please properly escape less-thans. x<y
46 | instead of x<y , and use " instead of
47 | " for string delimiters.
48 |
49 | is no longer applicable.
50 | Added noisefree's C#
51 | patch
53 | Added a distribution that has comments and
54 | whitespace removed to reduce download size from 45.5kB to 12.8kB.
55 |
56 | 4 Jul 2008
57 |
58 | Added language specific formatters that are triggered by the presence
59 | of a lang-<language-file-extension>
60 | Fixed bug : python handling of '''string'''
61 | Fixed bug: / in regex [charsets] should not end regex
62 |
63 | 5 Jul 2008
64 |
65 | Defined language extensions for Lisp and Lua
66 |
67 | 14 Jul 2008
68 |
69 | Language handlers for F#, OCAML, SQL
70 | Support for nocode spans to allow embedding of line
71 | numbers and code annotations which should not be styled or otherwise
72 | affect the tokenization of prettified code.
73 | See the issue 22
74 | testcase .
75 |
76 | 6 Jan 2009
77 |
78 | Language handlers for Visual Basic, Haskell, CSS, and WikiText
79 | Added .mxml extension to the markup style handler for
80 | Flex MXML files . See
81 | issue 37 .
84 | Added .m extension to the C style handler so that Objective
85 | C source files properly highlight. See
86 | issue 58 .
89 | Changed HTML lexer to use the same embedded source mechanism as the
90 | wiki language handler, and changed to use the registered
91 | CSS handler for STYLE element content.
92 |
93 | 21 May 2009
94 |
95 | Rewrote to improve performance on large files.
96 | See benchmarks .
97 | Fixed bugs with highlighting of Haskell line comments, Lisp
98 | number literals, Lua strings, C preprocessor directives,
99 | newlines in Wiki code on Windows, and newlines in IE6.
100 |
101 | 14 August 2009
102 |
103 | Fixed prettifying of <code> blocks with embedded newlines.
104 |
105 | 3 October 2009
106 |
107 | Fixed prettifying of XML/HTML tags that contain uppercase letters.
108 |
109 | 19 July 2010
110 |
111 | Added support for line numbers. Bug
112 | 22
114 | Added YAML support. Bug
115 | 123
117 | Added VHDL support courtesy Le Poussin.
118 | IE performance improvements. Bug
119 | 102 courtesy jacobly.
121 | A variety of markup formatting fixes courtesy smain and thezbyg.
122 | Fixed copy and paste in IE[678].
123 | Changed output to use   instead of
124 | so that the output works when embedded in XML.
125 | Bug
126 | 108 .
128 |
129 |
130 |
131 |
--------------------------------------------------------------------------------
/docs/assets/vendor/prettify/COPYING:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright [yyyy] [name of copyright owner]
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
203 |
--------------------------------------------------------------------------------
/docs/assets/vendor/prettify/README.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 | Javascript code prettifier
7 |
8 | Languages : CH
20 | Javascript code prettifier
21 |
22 | Setup
23 |
24 | Download a distribution
25 | Include the script and stylesheets in your document
26 | (you will need to make sure the css and js file are on your server, and
27 | adjust the paths in the script and link tag)
28 |
29 | <link href="prettify.css" type="text/css" rel="stylesheet" />
30 | <script type="text/javascript" src="prettify.js"></script>
31 | Add onload="prettyPrint()" to your
32 | document's body tag.
33 | Modify the stylesheet to get the coloring you prefer
34 |
35 |
36 | Usage
37 | Put code snippets in
38 | <pre class="prettyprint">...</pre>
39 | or <code class="prettyprint">...</code>
40 | and it will automatically be pretty printed.
41 |
42 |
43 |
44 | The original
45 | Prettier
46 |
47 | tags .
54 | }tags .
62 | }
64 |
65 | FAQ
66 | Which languages does it work for?
67 | The comments in prettify.js are authoritative but the lexer
68 | should work on a number of languages including C and friends,
69 | Java, Python, Bash, SQL, HTML, XML, CSS, Javascript, and Makefiles.
70 | It works passably on Ruby, PHP, VB, and Awk and a decent subset of Perl
71 | and Ruby, but, because of commenting conventions, doesn't work on
72 | Smalltalk, or CAML-like languages.
73 |
74 | LISPy languages are supported via an extension:
75 | lang-lisp.js
77 | And similarly for
78 | CSSHaskellLuaOCAML, SML, F#Visual BasicSQLProtocol BuffersWikiText
If you'd like to add an extension for your favorite language, please
96 | look at src/lang-lisp.js and file an
97 | issue including your language extension, and a testcase.
99 |
100 | How do I specify which language my code is in?
101 | You don't need to specify the language since prettyprint()
102 | will guess. You can specify a language by specifying the language extension
103 | along with the prettyprint class like so:
104 | <pre class="prettyprint lang-html ">
106 | The lang-* class specifies the language file extensions.
107 | File extensions supported by default include
108 | "bsh", "c", "cc", "cpp", "cs", "csh", "cyc", "cv", "htm", "html",
109 | "java", "js", "m", "mxml", "perl", "pl", "pm", "py", "rb", "sh",
110 | "xhtml", "xml", "xsl".
111 | </pre>
112 |
113 | It doesn't work on <obfuscated code sample> ?
114 | Yes. Prettifying obfuscated code is like putting lipstick on a pig
115 | — i.e. outside the scope of this tool.
116 |
117 | Which browsers does it work with?
118 | It's been tested with IE 6, Firefox 1.5 & 2, and Safari 2.0.4.
119 | Look at the test page to see if it
120 | works in your browser.
121 |
122 | What's changed?
123 | See the change log
124 |
125 | Why doesn't Prettyprinting of strings work on WordPress?
126 | Apparently wordpress does "smart quoting" which changes close quotes.
127 | This causes end quotes to not match up with open quotes.
128 |
This breaks prettifying as well as copying and pasting of code samples.
129 | See
130 | WordPress's help center for info on how to stop smart quoting of code
132 | snippets.
133 |
134 | How do I put line numbers in my code?
135 | You can use the linenums class to turn on line
136 | numbering. If your code doesn't start at line number 1, you can
137 | add a colon and a line number to the end of that class as in
138 | linenums:52.
139 |
140 |
For example
141 |
<pre class="prettyprint linenums:4 "
142 | >// This is line 4.
143 | foo();
144 | bar();
145 | baz();
146 | boo();
147 | far();
148 | faz();
149 | <pre>
150 | produces
151 | // This is line 4.
153 | foo();
154 | bar();
155 | baz();
156 | boo();
157 | far();
158 | faz();
159 |
160 |
161 | How do I prevent a portion of markup from being marked as code?
162 | You can use the nocode class to identify a span of markup
163 | that is not code.
164 |
<pre class=prettyprint>
165 | int x = foo(); /* This is a comment <span class="nocode">This is not code</span>
166 | Continuation of comment */
167 | int y = bar();
168 | </pre>
169 | produces
170 |
171 | int x = foo(); /* This is a comment This is not code
172 | Continuation of comment */
173 | int y = bar();
174 |
175 |
176 | For a more complete example see the issue22
177 | testcase .
178 |
179 | I get an error message "a is not a function" or "opt_whenDone is not a function"
180 | If you are calling prettyPrint via an event handler, wrap it in a function.
181 | Instead of doing
182 |
183 | addEventListener('load', prettyPrint, false);
185 |
186 | wrap it in a closure like
187 |
188 | addEventListener('load', function (event) { prettyPrint() }, false);
190 |
191 | so that the browser does not pass an event object to prettyPrint which
192 | will confuse it.
193 |
194 | 122)){if(!(am<65||ai>90)){ah.push([Math.max(65,ai)|32,Math.min(am,90)|32])}if(!(am<97||ai>122)){ah.push([Math.max(97,ai)&~32,Math.min(am,122)&~32])}}}}ah.sort(function(aw,av){return(aw[0]-av[0])||(av[1]-aw[1])});var ak=[];var aq=[];for(var at=0;atau[0]){if(au[1]+1>au[0]){ao.push("-")}ao.push(V(au[1]))}}ao.push("]");return ao.join("")}function Y(an){var al=an.source.match(new RegExp("(?:\\[(?:[^\\x5C\\x5D]|\\\\[\\s\\S])*\\]|\\\\u[A-Fa-f0-9]{4}|\\\\x[A-Fa-f0-9]{2}|\\\\[0-9]+|\\\\[^ux0-9]|\\(\\?[:!=]|[\\(\\)\\^]|[^\\x5B\\x5C\\(\\)\\^]+)","g"));var aj=al.length;var ap=[];for(var am=0,ao=0;am=2&&ak==="["){al[am]=Z(ai)}else{if(ak!=="\\"){al[am]=ai.replace(/[a-zA-Z]/g,function(aq){var ar=aq.charCodeAt(0);return"["+String.fromCharCode(ar&~32,ar|32)+"]"})}}}}return al.join("")}var ac=[];for(var X=0,W=ab.length;X=0;){U[ae.charAt(ag)]=aa}}var ah=aa[1];var ac=""+ah;if(!ai.hasOwnProperty(ac)){aj.push(ah);ai[ac]=null}}aj.push(/[\0-\uffff]/);X=l(aj)})();var Z=V.length;var Y=function(aj){var ab=aj.sourceCode,aa=aj.basePos;var af=[aa,G];var ah=0;var ap=ab.match(X)||[];var al={};for(var ag=0,at=ap.length;ag=5&&"lang-"===ar.substring(0,5);if(ao&&!(ak&&typeof ak[1]==="string")){ao=false;ar=K}if(!ao){al[ai]=ar}}var ad=ah;ah+=ai.length;if(!ao){af.push(aa+ad,ar)}else{var an=ak[1];var am=ai.indexOf(an);var ae=am+an.length;if(ak[2]){ae=ai.length-ak[2].length;am=ae-an.length}var au=ar.substring(5);C(aa+ad,ai.substring(0,am),Y,af);C(aa+ad+am,an,r(au,an),af);C(aa+ad+ae,ai.substring(ae),Y,af)}}aj.decorations=af};return Y}function i(V){var Y=[],U=[];if(V.tripleQuotedStrings){Y.push([D,/^(?:\'\'\'(?:[^\'\\]|\\[\s\S]|\'{1,2}(?=[^\']))*(?:\'\'\'|$)|\"\"\"(?:[^\"\\]|\\[\s\S]|\"{1,2}(?=[^\"]))*(?:\"\"\"|$)|\'(?:[^\\\']|\\[\s\S])*(?:\'|$)|\"(?:[^\\\"]|\\[\s\S])*(?:\"|$))/,null,"'\""])}else{if(V.multiLineStrings){Y.push([D,/^(?:\'(?:[^\\\']|\\[\s\S])*(?:\'|$)|\"(?:[^\\\"]|\\[\s\S])*(?:\"|$)|\`(?:[^\\\`]|\\[\s\S])*(?:\`|$))/,null,"'\"`"])}else{Y.push([D,/^(?:\'(?:[^\\\'\r\n]|\\.)*(?:\'|$)|\"(?:[^\\\"\r\n]|\\.)*(?:\"|$))/,null,"\"'"])}}if(V.verbatimStrings){U.push([D,/^@\"(?:[^\"]|\"\")*(?:\"|$)/,null])}var ab=V.hashComments;if(ab){if(V.cStyleComments){if(ab>1){Y.push([k,/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,null,"#"])}else{Y.push([k,/^#(?:(?:define|e(?:l|nd)if|else|error|ifn?def|include|line|pragma|undef|warning)\b|[^\r\n]*)/,null,"#"])}U.push([D,/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h(?:h|pp|\+\+)?|[a-z]\w*)>/,null])}else{Y.push([k,/^#[^\r\n]*/,null,"#"])}}if(V.cStyleComments){U.push([k,/^\/\/[^\r\n]*/,null]);U.push([k,/^\/\*[\s\S]*?(?:\*\/|$)/,null])}if(V.regexLiterals){var aa=("/(?=[^/*])(?:[^/\\x5B\\x5C]|\\x5C[\\s\\S]|\\x5B(?:[^\\x5C\\x5D]|\\x5C[\\s\\S])*(?:\\x5D|$))+/");U.push(["lang-regex",new RegExp("^"+N+"("+aa+")")])}var X=V.types;if(X){U.push([Q,X])}var W=(""+V.keywords).replace(/^ | $/g,"");if(W.length){U.push([A,new RegExp("^(?:"+W.replace(/[\s,]+/g,"|")+")\\b"),null])}Y.push([G,/^\s+/,null," \r\n\t\xA0"]);var Z=/^.[^\s\w\.$@\'\"\`\/\\]*/;U.push([H,/^@[a-z_$][a-z_$@0-9]*/i,null],[Q,/^(?:[@_]?[A-Z]+[a-z][A-Za-z_$@0-9]*|\w+_t\b)/,null],[G,/^[a-z_$][a-z_$@0-9]*/i,null],[H,new RegExp("^(?:0x[a-f0-9]+|(?:\\d(?:_\\d+)*\\d*(?:\\.\\d*)?|\\.\\d\\+)(?:e[+\\-]?\\d+)?)[a-z]*","i"),null,"0123456789"],[G,/^\\[\s\S]?/,null],[M,Z,null]);return h(Y,U)}var L=i({keywords:B,hashComments:true,cStyleComments:true,multiLineStrings:true,regexLiterals:true});function S(W,ah,aa){var V=/(?:^|\s)nocode(?:\s|$)/;var ac=/\r\n?|\n/;var ad=W.ownerDocument;var ag=ad.createElement("li");while(W.firstChild){ag.appendChild(W.firstChild)}var X=[ag];function af(am){switch(am.nodeType){case 1:if(V.test(am.className)){break}if("br"===am.nodeName){ae(am);if(am.parentNode){am.parentNode.removeChild(am)}}else{for(var ao=am.firstChild;ao;ao=ao.nextSibling){af(ao)}}break;case 3:case 4:if(aa){var an=am.nodeValue;var ak=an.match(ac);if(ak){var aj=an.substring(0,ak.index);am.nodeValue=aj;var ai=an.substring(ak.index+ak[0].length);if(ai){var al=am.parentNode;al.insertBefore(ad.createTextNode(ai),am.nextSibling)}ae(am);if(!aj){am.parentNode.removeChild(am)}}}break}}function ae(al){while(!al.nextSibling){al=al.parentNode;if(!al){return}}function aj(am,at){var ar=at?am.cloneNode(false):am;var ap=am.parentNode;if(ap){var aq=aj(ap,1);var ao=am.nextSibling;aq.appendChild(ar);for(var an=ao;an;an=ao){ao=an.nextSibling;aq.appendChild(an)}}return ar}var ai=aj(al.nextSibling,0);for(var ak;(ak=ai.parentNode)&&ak.nodeType===1;){ai=ak}X.push(ai)}for(var Z=0;Z=U){aj+=2}if(Y>=ar){ac+=2}}}finally{if(au){au.style.display=ak}}}var u={};function d(W,X){for(var U=X.length;--U>=0;){var V=X[U];if(!u.hasOwnProperty(V)){u[V]=W}else{if(O.console){console.warn("cannot override language handler %s",V)}}}}function r(V,U){if(!(V&&u.hasOwnProperty(V))){V=/^\s*]*(?:>|$)/],[k,/^<\!--[\s\S]*?(?:-\->|$)/],["lang-",/^<\?([\s\S]+?)(?:\?>|$)/],["lang-",/^<%([\s\S]+?)(?:%>|$)/],[M,/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\s\S]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\s\S]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\s\S]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),["default-markup","htm","html","mxml","xhtml","xml","xsl"]);d(h([[G,/^[\s]+/,null," \t\r\n"],[o,/^(?:\"[^\"]*\"?|\'[^\']*\'?)/,null,"\"'"]],[[n,/^^<\/?[a-z](?:[\w.:-]*\w)?|\/?>$/i],[R,/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^>\'\"\s]*(?:[^>\'\"\s\/]|\/(?=\s)))/],[M,/^[=<>\/]+/],["lang-js",/^on\w+\s*=\s*\"([^\"]+)\"/i],["lang-js",/^on\w+\s*=\s*\'([^\']+)\'/i],["lang-js",/^on\w+\s*=\s*([^\"\'>\s]+)/i],["lang-css",/^style\s*=\s*\"([^\"]+)\"/i],["lang-css",/^style\s*=\s*\'([^\']+)\'/i],["lang-css",/^style\s*=\s*([^\"\'>\s]+)/i]]),["in.tag"]);d(h([],[[o,/^[\s\S]+/]]),["uq.val"]);d(i({keywords:m,hashComments:true,cStyleComments:true,types:f}),["c","cc","cpp","cxx","cyc","m"]);d(i({keywords:"null,true,false"}),["json"]);d(i({keywords:T,hashComments:true,cStyleComments:true,verbatimStrings:true,types:f}),["cs"]);d(i({keywords:y,cStyleComments:true}),["java"]);d(i({keywords:I,hashComments:true,multiLineStrings:true}),["bsh","csh","sh"]);d(i({keywords:J,hashComments:true,multiLineStrings:true,tripleQuotedStrings:true}),["cv","py"]);d(i({keywords:t,hashComments:true,multiLineStrings:true,regexLiterals:true}),["perl","pl","pm"]);d(i({keywords:g,hashComments:true,multiLineStrings:true,regexLiterals:true}),["rb"]);d(i({keywords:x,cStyleComments:true,regexLiterals:true}),["js"]);d(i({keywords:s,hashComments:3,cStyleComments:true,multilineStrings:true,tripleQuotedStrings:true,regexLiterals:true}),["coffee"]);d(h([],[[D,/^[\s\S]+/]]),["regex"]);function e(X){var W=X.langExtension;try{var U=b(X.sourceNode,X.pre);var V=U.sourceCode;X.sourceCode=V;X.spans=U.spans;X.basePos=0;r(W,V)(X);E(X)}catch(Y){if(O.console){console.log(Y&&Y.stack?Y.stack:Y)}}}function z(Y,X,W){var U=document.createElement("pre");U.innerHTML=Y;if(W){S(U,W,true)}var V={langExtension:X,numberLines:W,sourceNode:U,pre:1};e(V);return U.innerHTML}function c(aj){function ab(al){return document.getElementsByTagName(al)}var ah=[ab("pre"),ab("code"),ab("xmp")];var V=[];for(var ae=0;ae]*(?:>|$)/],[PR.PR_COMMENT,/^<\!--[\s\S]*?(?:-\->|$)/],[PR.PR_PUNCTUATION,/^(?:<[%?]|[%?]>)/],["lang-",/^<\?([\s\S]+?)(?:\?>|$)/],["lang-",/^<%([\s\S]+?)(?:%>|$)/],["lang-",/^]*>([\s\S]+?)<\/xmp\b[^>]*>/i],["lang-handlebars",/^]*type\s*=\s*['"]?text\/x-handlebars-template['"]?\b[^>]*>([\s\S]*?)(<\/script\b[^>]*>)/i],["lang-js",/^]*>([\s\S]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\s\S]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i],[PR.PR_DECLARATION,/^{{[#^>/]?\s*[\w.][^}]*}}/],[PR.PR_DECLARATION,/^{{&?\s*[\w.][^}]*}}/],[PR.PR_DECLARATION,/^{{{>?\s*[\w.][^}]*}}}/],[PR.PR_COMMENT,/^{{![^}]*}}/]]),["handlebars","hbs"]);PR.registerLangHandler(PR.createSimpleLexer([[PR.PR_PLAIN,/^[ \t\r\n\f]+/,null," \t\r\n\f"]],[[PR.PR_STRING,/^\"(?:[^\n\r\f\\\"]|\\(?:\r\n?|\n|\f)|\\[\s\S])*\"/,null],[PR.PR_STRING,/^\'(?:[^\n\r\f\\\']|\\(?:\r\n?|\n|\f)|\\[\s\S])*\'/,null],["lang-css-str",/^url\(([^\)\"\']*)\)/i],[PR.PR_KEYWORD,/^(?:url|rgb|\!important|@import|@page|@media|@charset|inherit)(?=[^\-\w]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|(?:\\[0-9a-f]+ ?))(?:[_a-z0-9\-]|\\(?:\\[0-9a-f]+ ?))*)\s*:/i],[PR.PR_COMMENT,/^\/\*[^*]*\*+(?:[^\/*][^*]*\*+)*\//],[PR.PR_COMMENT,/^(?:)/],[PR.PR_LITERAL,/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],[PR.PR_LITERAL,/^#(?:[0-9a-f]{3}){1,2}/i],[PR.PR_PLAIN,/^-?(?:[_a-z]|(?:\\[\da-f]+ ?))(?:[_a-z\d\-]|\\(?:\\[\da-f]+ ?))*/i],[PR.PR_PUNCTUATION,/^[^\s\w\'\"]+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[[PR.PR_KEYWORD,/^-?(?:[_a-z]|(?:\\[\da-f]+ ?))(?:[_a-z\d\-]|\\(?:\\[\da-f]+ ?))*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[[PR.PR_STRING,/^[^\)\"\']+/]]),["css-str"]);
--------------------------------------------------------------------------------
/docs/classes/Mesh.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Mesh - kami
6 |
15 |
25 |
26 |
27 |
28 |
70 |
71 |
72 |
73 | Show:
74 |
75 |
78 |
79 |
80 |
83 |
84 |
85 |
88 |
89 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
Mesh Class
100 |
119 |
120 |
121 |
122 |
123 |
A mesh class that wraps VBO and IBO.
124 |
125 |
126 |
127 |
128 |
129 |
130 |
140 |
141 |
142 |
143 |
Item Index
144 |
145 |
146 |
147 |
148 |
149 |
Properties
150 |
151 |
152 |
153 |
154 | dirty
155 |
156 |
157 |
158 |
159 |
160 |
161 |
166 |
167 |
168 | vertexStride
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
185 |
186 |
187 |
Properties
188 |
189 |
190 |
191 |
dirty
192 |
Boolean
193 |
194 |
195 |
196 |
197 |
198 |
199 |
200 |
201 |
202 |
221 |
222 |
223 |
A write-only property which sets both vertices and indices
224 | flag to dirty or not.
225 |
226 |
227 |
228 |
229 |
230 |
231 |
232 |
233 |
234 |
235 |
236 |
237 |
238 |
Unknown
239 |
240 |
241 |
242 |
243 |
private
244 |
245 |
246 |
247 |
248 |
249 |
250 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 |
279 |
280 |
281 |
282 |
283 |
vertexStride
284 |
Number
285 |
286 |
287 |
288 |
289 |
290 |
291 |
292 |
293 |
294 |
313 |
314 |
315 |
The stride for one vertex in bytes .
316 |
317 |
318 |
319 |
320 |
321 |
322 |
323 |
324 |
325 |
326 |
327 |
328 |
329 |
330 |
331 |
332 |
333 |
334 |
335 |
336 |
337 |
338 |
339 |
340 |
341 |
Redirector
5 | Click here to redirect
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/files/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Redirector
5 | Click here to redirect
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/files/lib_TextureRegion.js.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | lib/TextureRegion.js - kami
6 |
15 |
25 |
26 |
27 |
28 |
70 |
71 |
72 |
73 | Show:
74 |
75 |
78 |
79 |
80 |
83 |
84 |
85 |
88 |
89 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
File: lib/TextureRegion.js
100 |
101 |
102 |
103 | var Class = require('klasse');
104 |
105 | //This is a GL-specific texture region, employing tangent space normalized coordinates U and V.
106 | //A canvas-specific region would really just be a lightweight object with { x, y, width, height }
107 | //in pixels.
108 | var TextureRegion = new Class({
109 |
110 | initialize: function TextureRegion(texture, x, y, width, height) {
111 | this.texture = texture;
112 | this.setRegion(x, y, width, height);
113 | },
114 |
115 | setUVs: function(u, v, u2, v2) {
116 | this.regionWidth = Math.round(Math.abs(u2 - u) * this.texture.width);
117 | this.regionHeight = Math.round(Math.abs(v2 - v) * this.texture.height);
118 |
119 | // From LibGDX TextureRegion.java --
120 | // For a 1x1 region, adjust UVs toward pixel center to avoid filtering artifacts on AMD GPUs when drawing very stretched.
121 | if (this.regionWidth == 1 && this.regionHeight == 1) {
122 | var adjustX = 0.25 / this.texture.width;
123 | u += adjustX;
124 | u2 -= adjustX;
125 | var adjustY = 0.25 / this.texture.height;
126 | v += adjustY;
127 | v2 -= adjustY;
128 | }
129 |
130 | this.u = u;
131 | this.v = v;
132 | this.u2 = u2;
133 | this.v2 = v2;
134 | },
135 |
136 | setRegion: function(x, y, width, height) {
137 | x = x || 0;
138 | y = y || 0;
139 | width = (width===0 || width) ? width : this.texture.width;
140 | height = (height===0 || height) ? height : this.texture.height;
141 |
142 | var invTexWidth = 1 / this.texture.width;
143 | var invTexHeight = 1 / this.texture.height;
144 | this.setUVs(x * invTexWidth, y * invTexHeight, (x + width) * invTexWidth, (y + height) * invTexHeight);
145 | this.regionWidth = Math.abs(width);
146 | this.regionHeight = Math.abs(height);
147 | },
148 |
149 | /** Sets the texture to that of the specified region and sets the coordinates relative to the specified region. */
150 | setFromRegion: function(region, x, y, width, height) {
151 | this.texture = region.texture;
152 | this.set(region.getRegionX() + x, region.getRegionY() + y, width, height);
153 | },
154 |
155 |
156 | //TODO: add setters for regionX/Y and regionWidth/Height
157 |
158 | regionX: {
159 | get: function() {
160 | return Math.round(this.u * this.texture.width);
161 | }
162 | },
163 |
164 | regionY: {
165 | get: function() {
166 | return Math.round(this.v * this.texture.height);
167 | }
168 | },
169 |
170 | flip: function(x, y) {
171 | var temp;
172 | if (x) {
173 | temp = this.u;
174 | this.u = this.u2;
175 | this.u2 = temp;
176 | }
177 | if (y) {
178 | temp = this.v;
179 | this.v = this.v2;
180 | this.v2 = temp;
181 | }
182 | }
183 | });
184 |
185 | module.exports = TextureRegion;
186 |
187 |
188 |
189 |
190 |
191 |
192 |
193 |
194 |
lib/WebGLContext.js - kami
6 |
15 |
25 |
26 |
27 |
28 |
70 |
71 |
72 |
73 | Show:
74 |
75 |
78 |
79 |
80 |
83 |
84 |
85 |
88 |
89 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
File: lib/WebGLContext.js
100 |
101 |
102 |
103 | /**
104 | * @module kami
105 | */
106 |
107 | var Class = require('klasse');
108 | var Signal = require('signals');
109 |
110 | /**
111 | * A thin wrapper around WebGLRenderingContext which handles
112 | * context loss and restore with various rendering objects (textures,
113 | * shaders and buffers). This also handles general viewport management.
114 | *
115 | * If the view is not specified, a canvas will be created.
116 | *
117 | * If the `view` parameter is an instanceof WebGLRenderingContext,
118 | * we will use its canvas and context without fetching another through `getContext`.
119 | * Passing a canvas that has already had `getContext('webgl')` called will not cause
120 | * errors, but in certain debuggers (e.g. Chrome WebGL Inspector) only the latest
121 | * context will be traced.
122 | *
123 | * @class WebGLContext
124 | * @constructor
125 | * @param {Number} width the width of the GL canvas
126 | * @param {Number} height the height of the GL canvas
127 | * @param {HTMLCanvasElement} view the optional DOM canvas element
128 | * @param {Object} contextAttribuets an object containing context attribs which
129 | * will be used during GL initialization
130 | */
131 | var WebGLContext = new Class({
132 |
133 | initialize: function WebGLContext(width, height, view, contextAttributes) {
134 | /**
135 | * The list of rendering objects (shaders, VBOs, textures, etc) which are
136 | * currently being managed. Any object with a "create" method can be added
137 | * to this list. Upon destroying the rendering object, it should be removed.
138 | * See addManagedObject and removeManagedObject.
139 | *
140 | * @property {Array} managedObjects
141 | */
142 | this.managedObjects = [];
143 |
144 | /**
145 | * The actual GL context. You can use this for
146 | * raw GL calls or to access GLenum constants. This
147 | * will be updated on context restore. While the WebGLContext
148 | * is not `valid`, you should not try to access GL state.
149 | *
150 | * @property gl
151 | * @type {WebGLRenderingContext}
152 | */
153 | this.gl = null;
154 |
155 | if (view && typeof window.WebGLRenderingContext !== "undefined"
156 | && view instanceof window.WebGLRenderingContext) {
157 | view = view.canvas;
158 | this.gl = view;
159 | this.valid = true;
160 | contextAttributes = undefined; //just ignore new attribs...
161 | }
162 |
163 | /**
164 | * The canvas DOM element for this context.
165 | * @property {Number} view
166 | */
167 | this.view = view || document.createElement("canvas");
168 |
169 | //default size as per spec:
170 | //http://www.w3.org/TR/2012/WD-html5-author-20120329/the-canvas-element.html#the-canvas-element
171 |
172 | /**
173 | * The width of this canvas.
174 | *
175 | * @property width
176 | * @type {Number}
177 | */
178 | this.width = this.view.width = width || 300;
179 |
180 | /**
181 | * The height of this canvas.
182 | * @property height
183 | * @type {Number}
184 | */
185 | this.height = this.view.height = height || 150;
186 |
187 |
188 | /**
189 | * The context attributes for initializing the GL state. This might include
190 | * anti-aliasing, alpha settings, verison, and so forth.
191 | *
192 | * @property {Object} contextAttributes
193 | */
194 | this.contextAttributes = contextAttributes;
195 |
196 | /**
197 | * Whether this context is 'valid', i.e. renderable. A context that has been lost
198 | * (and not yet restored) or destroyed is invalid.
199 | *
200 | * @property {Boolean} valid
201 | */
202 | this.valid = false;
203 |
204 | /**
205 | * A signal dispatched when GL context is lost.
206 | *
207 | * The first argument passed to the listener is the WebGLContext
208 | * managing the context loss.
209 | *
210 | * @event {Signal} lost
211 | */
212 | this.lost = new Signal();
213 |
214 | /**
215 | * A signal dispatched when GL context is restored, after all the managed
216 | * objects have been recreated.
217 | *
218 | * The first argument passed to the listener is the WebGLContext
219 | * which managed the restoration.
220 | *
221 | * This does not gaurentee that all objects will be renderable.
222 | * For example, a Texture with an ImageProvider may still be loading
223 | * asynchronously.
224 | *
225 | * @event {Signal} restored
226 | */
227 | this.restored = new Signal();
228 |
229 | //setup context lost and restore listeners
230 | this.view.addEventListener("webglcontextlost", function (ev) {
231 | ev.preventDefault();
232 | this._contextLost(ev);
233 | }.bind(this));
234 | this.view.addEventListener("webglcontextrestored", function (ev) {
235 | ev.preventDefault();
236 | this._contextRestored(ev);
237 | }.bind(this));
238 |
239 | if (!this.valid) //would only be valid if WebGLRenderingContext was passed
240 | this._initContext();
241 |
242 | this.resize(this.width, this.height);
243 | },
244 |
245 | _initContext: function() {
246 | var err = "";
247 | this.valid = false;
248 |
249 | try {
250 | this.gl = (this.view.getContext('webgl', this.contextAttributes)
251 | || this.view.getContext('experimental-webgl', this.contextAttributes));
252 | } catch (e) {
253 | this.gl = null;
254 | }
255 |
256 | if (this.gl) {
257 | this.valid = true;
258 | } else {
259 | throw "WebGL Context Not Supported -- try enabling it or using a different browser";
260 | }
261 | },
262 |
263 | /**
264 | * Updates the width and height of this WebGL context, resizes
265 | * the canvas view, and calls gl.viewport() with the new size.
266 | *
267 | * @param {Number} width the new width
268 | * @param {Number} height the new height
269 | */
270 | resize: function(width, height) {
271 | this.width = width;
272 | this.height = height;
273 |
274 | this.view.width = width;
275 | this.view.height = height;
276 |
277 | var gl = this.gl;
278 | gl.viewport(0, 0, this.width, this.height);
279 | },
280 |
281 | /**
282 | * (internal use)
283 | * A managed object is anything with a "create" function, that will
284 | * restore GL state after context loss.
285 | *
286 | * @param {[type]} tex [description]
287 | */
288 | addManagedObject: function(obj) {
289 | this.managedObjects.push(obj);
290 | },
291 |
292 | /**
293 | * (internal use)
294 | * Removes a managed object from the cache. This is useful to destroy
295 | * a texture or shader, and have it no longer re-load on context restore.
296 | *
297 | * Returns the object that was removed, or null if it was not found in the cache.
298 | *
299 | * @param {Object} obj the object to be managed
300 | * @return {Object} the removed object, or null
301 | */
302 | removeManagedObject: function(obj) {
303 | var idx = this.managedObjects.indexOf(obj);
304 | if (idx > -1) {
305 | this.managedObjects.splice(idx, 1);
306 | return obj;
307 | }
308 | return null;
309 | },
310 |
311 | /**
312 | * Calls destroy() on each managed object, then removes references to these objects
313 | * and the GL rendering context. This also removes references to the view and sets
314 | * the context's width and height to zero.
315 | *
316 | * Attempting to use this WebGLContext or the GL rendering context after destroying it
317 | * will lead to undefined behaviour.
318 | */
319 | destroy: function() {
320 | for (var i=0; i<this.managedObjects.length; i++) {
321 | var obj = this.managedObjects[i];
322 | if (obj && typeof obj.destroy === "function")
323 | obj.destroy();
324 | }
325 | this.managedObjects.length = 0;
326 | this.valid = false;
327 | this.gl = null;
328 | this.view = null;
329 | this.width = this.height = 0;
330 | },
331 |
332 | _contextLost: function(ev) {
333 | //all textures/shaders/buffers/FBOs have been deleted...
334 | //we need to re-create them on restore
335 | this.valid = false;
336 |
337 | this.lost.dispatch(this);
338 | },
339 |
340 | _contextRestored: function(ev) {
341 | //first, initialize the GL context again
342 | this._initContext();
343 |
344 | //now we recreate our shaders and textures
345 | for (var i=0; i<this.managedObjects.length; i++) {
346 | this.managedObjects[i].create();
347 | }
348 |
349 | //update GL viewport
350 | this.resize(this.width, this.height);
351 |
352 | this.restored.dispatch(this);
353 | }
354 | });
355 |
356 | module.exports = WebGLContext;
357 |
358 |
359 |
360 |
361 |
362 |
363 |
364 |
365 |
lib/glutils/FrameBuffer.js - kami
6 |
15 |
25 |
26 |
27 |
28 |
70 |
71 |
72 |
73 | Show:
74 |
75 |
78 |
79 |
80 |
83 |
84 |
85 |
88 |
89 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
File: lib/glutils/FrameBuffer.js
100 |
101 |
102 |
103 | var Class = require('klasse');
104 | var Texture = require('../Texture');
105 |
106 |
107 | var FrameBuffer = new Class({
108 |
109 | /**
110 | * Creates a new Frame Buffer Object with the given width and height.
111 | *
112 | * If width and height are non-numbers, this method expects the
113 | * first parameter to be a Texture object which should be acted upon.
114 | * In this case, the FrameBuffer does not "own" the texture, and so it
115 | * won't dispose of it upon destruction. This is an advanced version of the
116 | * constructor that assumes the user is giving us a valid Texture that can be bound (i.e.
117 | * no async Image textures).
118 | *
119 | * @class FrameBuffer
120 | * @constructor
121 | * @param {[type]} width [description]
122 | * @param {[type]} height [description]
123 | * @param {[type]} filter [description]
124 | * @return {[type]} [description]
125 | */
126 | initialize: function FrameBuffer(context, width, height, format) { //TODO: depth component
127 | if (typeof context !== "object")
128 | throw "GL context not specified to FrameBuffer";
129 |
130 |
131 | /**
132 | * The underlying ID of the GL frame buffer object.
133 | *
134 | * @property {WebGLFramebuffer} id
135 | */
136 | this.id = null;
137 |
138 | /**
139 | * The WebGLContext backed by this frame buffer.
140 | *
141 | * @property {WebGLContext} context
142 | */
143 | this.context = context;
144 |
145 | /**
146 | * The Texture backed by this frame buffer.
147 | *
148 | * @property {Texture} Texture
149 | */
150 | //this Texture is now managed.
151 | this.texture = new Texture(context, width, height, format);
152 |
153 | //This is maanged by WebGLContext
154 | this.context.addManagedObject(this);
155 | this.create();
156 | },
157 |
158 | /**
159 | * A read-only property which returns the width of the backing texture.
160 | *
161 | * @readOnly
162 | * @property width
163 | * @type {Number}
164 | */
165 | width: {
166 | get: function() {
167 | return this.texture.width
168 | }
169 | },
170 |
171 | /**
172 | * A read-only property which returns the height of the backing texture.
173 | *
174 | * @readOnly
175 | * @property height
176 | * @type {Number}
177 | */
178 | height: {
179 | get: function() {
180 | return this.texture.height;
181 | }
182 | },
183 |
184 |
185 | /**
186 | * Called during initialization to setup the frame buffer; also called on
187 | * context restore. Users will not need to call this directly.
188 | *
189 | * @method create
190 | */
191 | create: function() {
192 | this.gl = this.context.gl;
193 | var gl = this.gl;
194 |
195 | var tex = this.texture;
196 |
197 | //we assume the texture has already had create() called on it
198 | //since it was added as a managed object prior to this FrameBuffer
199 | tex.bind();
200 |
201 | this.id = gl.createFramebuffer();
202 | gl.bindFramebuffer(gl.FRAMEBUFFER, this.id);
203 |
204 | gl.framebufferTexture2D(gl.FRAMEBUFFER, gl.COLOR_ATTACHMENT0, tex.target, tex.id, 0);
205 |
206 | var result = gl.checkFramebufferStatus(gl.FRAMEBUFFER);
207 | if (result != gl.FRAMEBUFFER_COMPLETE) {
208 | this.destroy(); //destroy our resources before leaving this function..
209 |
210 | var err = "Framebuffer not complete";
211 | switch (result) {
212 | case gl.FRAMEBUFFER_UNSUPPORTED:
213 | throw new Error(err + ": unsupported");
214 | case gl.INCOMPLETE_DIMENSIONS:
215 | throw new Error(err + ": incomplete dimensions");
216 | case gl.INCOMPLETE_ATTACHMENT:
217 | throw new Error(err + ": incomplete attachment");
218 | case gl.INCOMPLETE_MISSING_ATTACHMENT:
219 | throw new Error(err + ": missing attachment");
220 | default:
221 | throw new Error(err);
222 | }
223 | }
224 | gl.bindFramebuffer(gl.FRAMEBUFFER, null);
225 | },
226 |
227 |
228 | /**
229 | * Destroys this frame buffer. Using this object after destroying it will have
230 | * undefined results.
231 | * @method destroy
232 | */
233 | destroy: function() {
234 | var gl = this.gl;
235 |
236 | if (this.texture)
237 | this.texture.destroy();
238 | if (this.id && this.gl)
239 | this.gl.deleteFramebuffer(this.id);
240 | if (this.context)
241 | this.context.removeManagedObject(this);
242 |
243 | this.id = null;
244 | this.gl = null;
245 | this.texture = null;
246 | this.context = null;
247 | },
248 |
249 | /**
250 | * Binds this framebuffer and sets the viewport to the expected size.
251 | * @method begin
252 | */
253 | begin: function() {
254 | var gl = this.gl;
255 | gl.viewport(0, 0, this.texture.width, this.texture.height);
256 | gl.bindFramebuffer(gl.FRAMEBUFFER, this.id);
257 | },
258 |
259 | /**
260 | * Binds the default frame buffer (the screen) and sets the viewport back
261 | * to the size of the WebGLContext.
262 | *
263 | * @method end
264 | */
265 | end: function() {
266 | var gl = this.gl;
267 | gl.viewport(0, 0, this.context.width, this.context.height);
268 | gl.bindFramebuffer(gl.FRAMEBUFFER, null);
269 | }
270 | });
271 |
272 | module.exports = FrameBuffer;
273 |
274 |
275 |
276 |
277 |
278 |
279 |
280 |
281 |
lib/glutils/Mesh.js - kami
6 |
15 |
25 |
26 |
27 |
28 |
70 |
71 |
72 |
73 | Show:
74 |
75 |
78 |
79 |
80 |
83 |
84 |
85 |
88 |
89 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
File: lib/glutils/Mesh.js
100 |
101 |
102 |
103 | /**
104 | * @module kami
105 | */
106 |
107 | var Class = require('klasse');
108 |
109 | //TODO: decouple into VBO + IBO utilities
110 | /**
111 | * A mesh class that wraps VBO and IBO.
112 | *
113 | * @class Mesh
114 | */
115 | var Mesh = new Class({
116 |
117 |
118 | /**
119 | * A write-only property which sets both vertices and indices
120 | * flag to dirty or not.
121 | *
122 | * @property dirty
123 | * @type {Boolean}
124 | * @writeOnly
125 | */
126 | dirty: {
127 | set: function(val) {
128 | this.verticesDirty = val;
129 | this.indicesDirty = val;
130 | }
131 | },
132 |
133 | /**
134 | * Creates a new Mesh with the provided parameters.
135 | *
136 | * If numIndices is 0 or falsy, no index buffer will be used
137 | * and indices will be an empty ArrayBuffer and a null indexBuffer.
138 | *
139 | * If isStatic is true, then vertexUsage and indexUsage will
140 | * be set to gl.STATIC_DRAW. Otherwise they will use gl.DYNAMIC_DRAW.
141 | * You may want to adjust these after initialization for further control.
142 | *
143 | * @param {WebGLContext} context the context for management
144 | * @param {Boolean} isStatic a hint as to whether this geometry is static
145 | * @param {[type]} numVerts [description]
146 | * @param {[type]} numIndices [description]
147 | * @param {[type]} vertexAttribs [description]
148 | * @return {[type]} [description]
149 | */
150 | initialize: function Mesh(context, isStatic, numVerts, numIndices, vertexAttribs) {
151 | if (typeof context !== "object")
152 | throw "GL context not specified to Mesh";
153 | if (!numVerts)
154 | throw "numVerts not specified, must be > 0";
155 |
156 | this.context = context;
157 | this.gl = context.gl;
158 |
159 | this.numVerts = null;
160 | this.numIndices = null;
161 |
162 | this.vertices = null;
163 | this.indices = null;
164 | this.vertexBuffer = null;
165 | this.indexBuffer = null;
166 |
167 | this.verticesDirty = true;
168 | this.indicesDirty = true;
169 | this.indexUsage = null;
170 | this.vertexUsage = null;
171 |
172 | /**
173 | * @property
174 | * @private
175 | */
176 | this._vertexAttribs = null;
177 |
178 | /**
179 | * The stride for one vertex _in bytes_.
180 | *
181 | * @property {Number} vertexStride
182 | */
183 | this.vertexStride = null;
184 |
185 | this.numVerts = numVerts;
186 | this.numIndices = numIndices || 0;
187 | this.vertexUsage = isStatic ? this.gl.STATIC_DRAW : this.gl.DYNAMIC_DRAW;
188 | this.indexUsage = isStatic ? this.gl.STATIC_DRAW : this.gl.DYNAMIC_DRAW;
189 | this._vertexAttribs = vertexAttribs || [];
190 |
191 | this.indicesDirty = true;
192 | this.verticesDirty = true;
193 |
194 | //determine the vertex stride based on given attributes
195 | var totalNumComponents = 0;
196 | for (var i=0; i<this._vertexAttribs.length; i++)
197 | totalNumComponents += this._vertexAttribs[i].offsetCount;
198 | this.vertexStride = totalNumComponents * 4; // in bytes
199 |
200 | this.vertices = new Float32Array(this.numVerts);
201 | this.indices = new Uint16Array(this.numIndices);
202 |
203 | //add this VBO to the managed cache
204 | this.context.addManagedObject(this);
205 |
206 | this.create();
207 | },
208 |
209 | //recreates the buffers on context loss
210 | create: function() {
211 | this.gl = this.context.gl;
212 | var gl = this.gl;
213 | this.vertexBuffer = gl.createBuffer();
214 |
215 | //ignore index buffer if we haven't specified any
216 | this.indexBuffer = this.numIndices > 0
217 | ? gl.createBuffer()
218 | : null;
219 |
220 | this.dirty = true;
221 | },
222 |
223 | destroy: function() {
224 | this.vertices = null;
225 | this.indices = null;
226 | if (this.vertexBuffer && this.gl)
227 | this.gl.deleteBuffer(this.vertexBuffer);
228 | if (this.indexBuffer && this.gl)
229 | this.gl.deleteBuffer(this.indexBuffer);
230 | this.vertexBuffer = null;
231 | this.indexBuffer = null;
232 | if (this.context)
233 | this.context.removeManagedObject(this);
234 | this.gl = null;
235 | this.context = null;
236 | },
237 |
238 | _updateBuffers: function(ignoreBind, subDataLength) {
239 | var gl = this.gl;
240 |
241 | //bind our index data, if we have any
242 | if (this.numIndices > 0) {
243 | if (!ignoreBind)
244 | gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, this.indexBuffer);
245 |
246 | //update the index data
247 | if (this.indicesDirty) {
248 | gl.bufferData(gl.ELEMENT_ARRAY_BUFFER, this.indices, this.indexUsage);
249 | this.indicesDirty = false;
250 | }
251 | }
252 |
253 | //bind our vertex data
254 | if (!ignoreBind)
255 | gl.bindBuffer(gl.ARRAY_BUFFER, this.vertexBuffer);
256 |
257 | //update our vertex data
258 | if (this.verticesDirty) {
259 | if (subDataLength) {
260 | // TODO: When decoupling VBO/IBO be sure to give better subData support..
261 | var view = this.vertices.subarray(0, subDataLength);
262 | gl.bufferSubData(gl.ARRAY_BUFFER, 0, view);
263 | } else {
264 | gl.bufferData(gl.ARRAY_BUFFER, this.vertices, this.vertexUsage);
265 | }
266 |
267 |
268 | this.verticesDirty = false;
269 | }
270 | },
271 |
272 | draw: function(primitiveType, count, offset, subDataLength) {
273 | if (count === 0)
274 | return;
275 |
276 | var gl = this.gl;
277 |
278 | offset = offset || 0;
279 |
280 | //binds and updates our buffers. pass ignoreBind as true
281 | //to avoid binding unnecessarily
282 | this._updateBuffers(true, subDataLength);
283 |
284 | if (this.numIndices > 0) {
285 | gl.drawElements(primitiveType, count,
286 | gl.UNSIGNED_SHORT, offset * 2); //* Uint16Array.BYTES_PER_ELEMENT
287 | } else
288 | gl.drawArrays(primitiveType, offset, count);
289 | },
290 |
291 | //binds this mesh's vertex attributes for the given shader
292 | bind: function(shader) {
293 | var gl = this.gl;
294 |
295 | var offset = 0;
296 | var stride = this.vertexStride;
297 |
298 | //bind and update our vertex data before binding attributes
299 | this._updateBuffers();
300 |
301 | //for each attribtue
302 | for (var i=0; i<this._vertexAttribs.length; i++) {
303 | var a = this._vertexAttribs[i];
304 |
305 | //location of the attribute
306 | var loc = a.location === null
307 | ? shader.getAttributeLocation(a.name)
308 | : a.location;
309 |
310 | //TODO: We may want to skip unfound attribs
311 | // if (loc!==0 && !loc)
312 | // console.warn("WARN:", a.name, "is not enabled");
313 |
314 | //first, enable the vertex array
315 | gl.enableVertexAttribArray(loc);
316 |
317 | //then specify our vertex format
318 | gl.vertexAttribPointer(loc, a.numComponents, a.type || gl.FLOAT,
319 | a.normalize, stride, offset);
320 |
321 | //and increase the offset...
322 | offset += a.offsetCount * 4; //in bytes
323 | }
324 | },
325 |
326 | unbind: function(shader) {
327 | var gl = this.gl;
328 |
329 | //for each attribtue
330 | for (var i=0; i<this._vertexAttribs.length; i++) {
331 | var a = this._vertexAttribs[i];
332 |
333 | //location of the attribute
334 | var loc = a.location === null
335 | ? shader.getAttributeLocation(a.name)
336 | : a.location;
337 |
338 | //first, enable the vertex array
339 | gl.disableVertexAttribArray(loc);
340 | }
341 | }
342 | });
343 |
344 | Mesh.Attrib = new Class({
345 |
346 | name: null,
347 | numComponents: null,
348 | location: null,
349 | type: null,
350 |
351 | /**
352 | * Location is optional and for advanced users that
353 | * want vertex arrays to match across shaders. Any non-numerical
354 | * value will be converted to null, and ignored. If a numerical
355 | * value is given, it will override the position of this attribute
356 | * when given to a mesh.
357 | *
358 | * @param {[type]} name [description]
359 | * @param {[type]} numComponents [description]
360 | * @param {[type]} location [description]
361 | * @return {[type]} [description]
362 | */
363 | initialize: function(name, numComponents, location, type, normalize, offsetCount) {
364 | this.name = name;
365 | this.numComponents = numComponents;
366 | this.location = typeof location === "number" ? location : null;
367 | this.type = type;
368 | this.normalize = Boolean(normalize);
369 | this.offsetCount = typeof offsetCount === "number" ? offsetCount : this.numComponents;
370 | }
371 | })
372 |
373 |
374 | module.exports = Mesh;
375 |
376 |
377 |
378 |
379 |
380 |
381 |
382 |
383 |
lib/index-umd.js - kami
6 |
15 |
25 |
26 |
27 |
28 |
70 |
71 |
72 |
73 | Show:
74 |
75 |
78 |
79 |
80 |
83 |
84 |
85 |
88 |
89 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
File: lib/index-umd.js
100 |
101 |
102 |
103 | /**
104 | Auto-generated Kami index file.
105 | Dependencies are placed on the top-level namespace, for convenience.
106 | Created on 2014-06-11.
107 | */
108 | module.exports = {
109 | //core classes
110 | 'BaseBatch': require('./BaseBatch.js'),
111 | 'SpriteBatch': require('./SpriteBatch.js'),
112 | 'Texture': require('./Texture.js'),
113 | 'TextureRegion': require('./TextureRegion.js'),
114 | 'WebGLContext': require('./WebGLContext.js'),
115 | 'FrameBuffer': require('./glutils/FrameBuffer.js'),
116 | 'Mesh': require('./glutils/Mesh.js'),
117 | 'ShaderProgram': require('./glutils/ShaderProgram.js'),
118 |
119 | //signals dependencies
120 | 'Signal': require('signals').Signal,
121 |
122 | //klasse dependencies
123 | 'Class': require('klasse'),
124 |
125 | //number-util dependencies
126 | 'NumberUtil': require('number-util')
127 | };
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
136 |
lib/index.js - kami
6 |
15 |
25 |
26 |
27 |
28 |
70 |
71 |
72 |
73 | Show:
74 |
75 |
78 |
79 |
80 |
83 |
84 |
85 |
88 |
89 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
File: lib/index.js
100 |
101 |
102 |
103 | /**
104 | Auto-generated Kami index file.
105 | Created on 2014-06-11.
106 | */
107 | module.exports = {
108 | //core classes
109 | 'BaseBatch': require('./BaseBatch.js'),
110 | 'SpriteBatch': require('./SpriteBatch.js'),
111 | 'Texture': require('./Texture.js'),
112 | 'TextureRegion': require('./TextureRegion.js'),
113 | 'WebGLContext': require('./WebGLContext.js'),
114 | 'FrameBuffer': require('./glutils/FrameBuffer.js'),
115 | 'Mesh': require('./glutils/Mesh.js'),
116 | 'ShaderProgram': require('./glutils/ShaderProgram.js')
117 | };
118 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
126 |
kami
6 |
15 |
25 |
26 |
27 |
28 |
70 |
71 |
72 |
73 | Show:
74 |
75 |
78 |
79 |
80 |
83 |
84 |
85 |
88 |
89 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
100 |
101 |
102 | Browse to a module or class using the sidebar to view its API documentation.
103 |
104 |
105 |
Keyboard Shortcuts
106 |
107 |
108 | Press s to focus the API search box.
Use Up and Down to select classes, modules, and search results.
With the API search box or sidebar focused, use ⌘ -Left⌘ -Right
With the API search box or sidebar focused, use Ctrl+Left and Ctrl+Right to switch sidebar tabs.
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
126 |
Redirector
5 | Click here to redirect
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/modules/kami.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | kami - kami
6 |
15 |
25 |
26 |
27 |
28 |
70 |
71 |
72 |
73 | Show:
74 |
75 |
78 |
79 |
80 |
83 |
84 |
85 |
88 |
89 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
kami Module
100 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
This module provides the following classes:
126 |
127 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
185 |
0";
53 |
54 | this.context = context;
55 | this.gl = context.gl;
56 |
57 | this.numVerts = null;
58 | this.numIndices = null;
59 |
60 | this.vertices = null;
61 | this.indices = null;
62 | this.vertexBuffer = null;
63 | this.indexBuffer = null;
64 |
65 | this.verticesDirty = true;
66 | this.indicesDirty = true;
67 | this.indexUsage = null;
68 | this.vertexUsage = null;
69 |
70 | /**
71 | * @property
72 | * @private
73 | */
74 | this._vertexAttribs = null;
75 |
76 | /**
77 | * The stride for one vertex _in bytes_.
78 | *
79 | * @property {Number} vertexStride
80 | */
81 | this.vertexStride = null;
82 |
83 | this.numVerts = numVerts;
84 | this.numIndices = numIndices || 0;
85 | this.vertexUsage = isStatic ? this.gl.STATIC_DRAW : this.gl.DYNAMIC_DRAW;
86 | this.indexUsage = isStatic ? this.gl.STATIC_DRAW : this.gl.DYNAMIC_DRAW;
87 | this._vertexAttribs = vertexAttribs || [];
88 |
89 | this.indicesDirty = true;
90 | this.verticesDirty = true;
91 |
92 | //determine the vertex stride based on given attributes
93 | var totalNumComponents = 0;
94 | for (var i=0; i 0
115 | ? gl.createBuffer()
116 | : null;
117 |
118 | this.dirty = true;
119 | },
120 |
121 | destroy: function() {
122 | this.vertices = null;
123 | this.indices = null;
124 | if (this.vertexBuffer && this.gl)
125 | this.gl.deleteBuffer(this.vertexBuffer);
126 | if (this.indexBuffer && this.gl)
127 | this.gl.deleteBuffer(this.indexBuffer);
128 | this.vertexBuffer = null;
129 | this.indexBuffer = null;
130 | if (this.context)
131 | this.context.removeManagedObject(this);
132 | this.gl = null;
133 | this.context = null;
134 | },
135 |
136 | _updateBuffers: function(ignoreBind, subDataLength) {
137 | var gl = this.gl;
138 |
139 | //bind our index data, if we have any
140 | if (this.numIndices > 0) {
141 | if (!ignoreBind)
142 | gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, this.indexBuffer);
143 |
144 | //update the index data
145 | if (this.indicesDirty) {
146 | gl.bufferData(gl.ELEMENT_ARRAY_BUFFER, this.indices, this.indexUsage);
147 | this.indicesDirty = false;
148 | }
149 | }
150 |
151 | //bind our vertex data
152 | if (!ignoreBind)
153 | gl.bindBuffer(gl.ARRAY_BUFFER, this.vertexBuffer);
154 |
155 | //update our vertex data
156 | if (this.verticesDirty) {
157 | if (subDataLength) {
158 | // TODO: When decoupling VBO/IBO be sure to give better subData support..
159 | var view = this.vertices.subarray(0, subDataLength);
160 | gl.bufferSubData(gl.ARRAY_BUFFER, 0, view);
161 | } else {
162 | gl.bufferData(gl.ARRAY_BUFFER, this.vertices, this.vertexUsage);
163 | }
164 |
165 |
166 | this.verticesDirty = false;
167 | }
168 | },
169 |
170 | draw: function(primitiveType, count, offset, subDataLength) {
171 | if (count === 0)
172 | return;
173 |
174 | var gl = this.gl;
175 |
176 | offset = offset || 0;
177 |
178 | //binds and updates our buffers. pass ignoreBind as true
179 | //to avoid binding unnecessarily
180 | this._updateBuffers(true, subDataLength);
181 |
182 | if (this.numIndices > 0) {
183 | gl.drawElements(primitiveType, count,
184 | gl.UNSIGNED_SHORT, offset * 2); //* Uint16Array.BYTES_PER_ELEMENT
185 | } else
186 | gl.drawArrays(primitiveType, offset, count);
187 | },
188 |
189 | //binds this mesh's vertex attributes for the given shader
190 | bind: function(shader) {
191 | var gl = this.gl;
192 |
193 | var offset = 0;
194 | var stride = this.vertexStride;
195 |
196 | //bind and update our vertex data before binding attributes
197 | this._updateBuffers();
198 |
199 | //for each attribtue
200 | for (var i=0; i pairs.
13 | *
14 | * _Note:_ Chrome version 31 was giving me issues with attribute locations -- you may
15 | * want to omit this to let the browser pick the locations for you.
16 | *
17 | * @class ShaderProgram
18 | * @constructor
19 | * @param {WebGLContext} context the context to manage this object
20 | * @param {String} vertSource the vertex shader source
21 | * @param {String} fragSource the fragment shader source
22 | * @param {Object} attributeLocations the attribute locations
23 | */
24 | initialize: function ShaderProgram(context, vertSource, fragSource, attributeLocations) {
25 | if (!vertSource || !fragSource)
26 | throw "vertex and fragment shaders must be defined";
27 | if (typeof context !== "object")
28 | throw "GL context not specified to ShaderProgram";
29 | this.context = context;
30 |
31 | this.vertShader = null;
32 | this.fragShader = null;
33 | this.program = null;
34 | this.log = "";
35 |
36 | this.uniformCache = null;
37 | this.attributeCache = null;
38 |
39 | this.attributeLocations = attributeLocations;
40 |
41 | //We trim (ECMAScript5) so that the GLSL line numbers are
42 | //accurate on shader log
43 | this.vertSource = vertSource.trim();
44 | this.fragSource = fragSource.trim();
45 |
46 | //Adds this shader to the context, to be managed
47 | this.context.addManagedObject(this);
48 |
49 | this.create();
50 | },
51 |
52 | /**
53 | * This is called during the ShaderProgram constructor,
54 | * and may need to be called again after context loss and restore.
55 | *
56 | * @method create
57 | */
58 | create: function() {
59 | this.gl = this.context.gl;
60 | this._compileShaders();
61 | },
62 |
63 | //Compiles the shaders, throwing an error if the program was invalid.
64 | _compileShaders: function() {
65 | var gl = this.gl;
66 |
67 | this.log = "";
68 |
69 | this.vertShader = this._loadShader(gl.VERTEX_SHADER, this.vertSource);
70 | this.fragShader = this._loadShader(gl.FRAGMENT_SHADER, this.fragSource);
71 |
72 | if (!this.vertShader || !this.fragShader)
73 | throw "Error returned when calling createShader";
74 |
75 | this.program = gl.createProgram();
76 |
77 | gl.attachShader(this.program, this.vertShader);
78 | gl.attachShader(this.program, this.fragShader);
79 |
80 | //TODO: This seems not to be working on my OSX -- maybe a driver bug?
81 | if (this.attributeLocations) {
82 | for (var key in this.attributeLocations) {
83 | if (this.attributeLocations.hasOwnProperty(key)) {
84 | gl.bindAttribLocation(this.program, Math.floor(this.attributeLocations[key]), key);
85 | }
86 | }
87 | }
88 |
89 | gl.linkProgram(this.program);
90 |
91 | this.log += gl.getProgramInfoLog(this.program) || "";
92 |
93 | if (!gl.getProgramParameter(this.program, gl.LINK_STATUS)) {
94 | throw "Error linking the shader program:\n"
95 | + this.log;
96 | }
97 |
98 | this._fetchUniforms();
99 | this._fetchAttributes();
100 | },
101 |
102 | _fetchUniforms: function() {
103 | var gl = this.gl;
104 |
105 | this.uniformCache = {};
106 |
107 | var len = gl.getProgramParameter(this.program, gl.ACTIVE_UNIFORMS);
108 | if (!len) //null or zero
109 | return;
110 |
111 | for (var i=0; i .. whatever that is ??
384 |
385 |
386 | /////
387 |
388 | /**
389 | * A convenience method to set uniformNfv from the given ArrayBuffer.
390 | * We determine which GL call to make based on the length of the array
391 | * buffer (for 1-4 component vectors stored in a Float32Array). To use
392 | * this method to upload data to uniform arrays, you need to specify the
393 | * 'count' parameter; i.e. the data type you are using for that array. If
394 | * specified, this will dictate whether to call uniform1fv, uniform2fv, etc.
395 | *
396 | * @method setUniformfv
397 | * @param {String} name the name of the uniform
398 | * @param {ArrayBuffer} arrayBuffer the array buffer
399 | * @param {Number} count optional, the explicit data type count, e.g. 2 for vec2
400 | */
401 | setUniformfv: function(name, arrayBuffer, count) {
402 | 'use strict';
403 | count = count || arrayBuffer.length;
404 | var gl = this.gl;
405 | var loc = this.getUniformLocation(name);
406 | if (loc === null)
407 | return false;
408 | switch (count) {
409 | case 1: gl.uniform1fv(loc, arrayBuffer); return true;
410 | case 2: gl.uniform2fv(loc, arrayBuffer); return true;
411 | case 3: gl.uniform3fv(loc, arrayBuffer); return true;
412 | case 4: gl.uniform4fv(loc, arrayBuffer); return true;
413 | default:
414 | throw "invalid arguments to setUniformf";
415 | }
416 | },
417 |
418 | /**
419 | * A convenience method to set uniformNiv from the given ArrayBuffer.
420 | * We determine which GL call to make based on the length of the array
421 | * buffer (for 1-4 component vectors stored in a int array). To use
422 | * this method to upload data to uniform arrays, you need to specify the
423 | * 'count' parameter; i.e. the data type you are using for that array. If
424 | * specified, this will dictate whether to call uniform1fv, uniform2fv, etc.
425 | *
426 | * @method setUniformiv
427 | * @param {String} name the name of the uniform
428 | * @param {ArrayBuffer} arrayBuffer the array buffer
429 | * @param {Number} count optional, the explicit data type count, e.g. 2 for ivec2
430 | */
431 | setUniformiv: function(name, arrayBuffer, count) {
432 | 'use strict';
433 | count = count || arrayBuffer.length;
434 | var gl = this.gl;
435 | var loc = this.getUniformLocation(name);
436 | if (loc === null)
437 | return false;
438 | switch (count) {
439 | case 1: gl.uniform1iv(loc, arrayBuffer); return true;
440 | case 2: gl.uniform2iv(loc, arrayBuffer); return true;
441 | case 3: gl.uniform3iv(loc, arrayBuffer); return true;
442 | case 4: gl.uniform4iv(loc, arrayBuffer); return true;
443 | default:
444 | throw "invalid arguments to setUniformf";
445 | }
446 | },
447 |
448 | /**
449 | * This is a convenience function to pass a Matrix3 (from vecmath,
450 | * kami's preferred math library) or a Float32Array (e.g. gl-matrix)
451 | * to a shader. If mat is an object with "val", it is considered to be
452 | * a Matrix3, otherwise assumed to be a typed array being passed directly
453 | * to the shader.
454 | *
455 | * @param {String} name the uniform name
456 | * @param {Matrix3|Float32Array} mat a Matrix3 or Float32Array
457 | * @param {Boolean} transpose whether to transpose the matrix, default false
458 | */
459 | setUniformMatrix3: function(name, mat, transpose) {
460 | 'use strict';
461 | var arr = typeof mat === "object" && mat.val ? mat.val : mat;
462 | transpose = !!transpose; //to boolean
463 |
464 | var gl = this.gl;
465 | var loc = this.getUniformLocation(name);
466 | if (loc === null)
467 | return false;
468 | gl.uniformMatrix3fv(loc, transpose, arr)
469 | },
470 |
471 | /**
472 | * This is a convenience function to pass a Matrix4 (from vecmath,
473 | * kami's preferred math library) or a Float32Array (e.g. gl-matrix)
474 | * to a shader. If mat is an object with "val", it is considered to be
475 | * a Matrix4, otherwise assumed to be a typed array being passed directly
476 | * to the shader.
477 | *
478 | * @param {String} name the uniform name
479 | * @param {Matrix4|Float32Array} mat a Matrix4 or Float32Array
480 | * @param {Boolean} transpose whether to transpose the matrix, default false
481 | */
482 | setUniformMatrix4: function(name, mat, transpose) {
483 | 'use strict';
484 | var arr = typeof mat === "object" && mat.val ? mat.val : mat;
485 | transpose = !!transpose; //to boolean
486 |
487 | var gl = this.gl;
488 | var loc = this.getUniformLocation(name);
489 | if (loc === null)
490 | return false;
491 | gl.uniformMatrix4fv(loc, transpose, arr)
492 | }
493 |
494 | });
495 |
496 | //Some default attribute names that parts of kami will use
497 | //when creating a standard shader.
498 | ShaderProgram.POSITION_ATTRIBUTE = "Position";
499 | ShaderProgram.NORMAL_ATTRIBUTE = "Normal";
500 | ShaderProgram.COLOR_ATTRIBUTE = "Color";
501 | ShaderProgram.TEXCOORD_ATTRIBUTE = "TexCoord";
502 |
503 | module.exports = ShaderProgram;
--------------------------------------------------------------------------------
/lib/index-umd.js:
--------------------------------------------------------------------------------
1 | /**
2 | Auto-generated Kami index file.
3 | Dependencies are placed on the top-level namespace, for convenience.
4 | Created on 2014-06-11.
5 | */
6 | module.exports = {
7 | //core classes
8 | 'BaseBatch': require('./BaseBatch.js'),
9 | 'SpriteBatch': require('./SpriteBatch.js'),
10 | 'Texture': require('./Texture.js'),
11 | 'TextureRegion': require('./TextureRegion.js'),
12 | 'WebGLContext': require('./WebGLContext.js'),
13 | 'FrameBuffer': require('./glutils/FrameBuffer.js'),
14 | 'Mesh': require('./glutils/Mesh.js'),
15 | 'ShaderProgram': require('./glutils/ShaderProgram.js'),
16 |
17 | //signals dependencies
18 | 'Signal': require('signals').Signal,
19 |
20 | //klasse dependencies
21 | 'Class': require('klasse'),
22 |
23 | //number-util dependencies
24 | 'NumberUtil': require('number-util')
25 | };
--------------------------------------------------------------------------------
/lib/index.js:
--------------------------------------------------------------------------------
1 | /**
2 | Auto-generated Kami index file.
3 | Created on 2014-06-11.
4 | */
5 | module.exports = {
6 | //core classes
7 | 'BaseBatch': require('./BaseBatch.js'),
8 | 'SpriteBatch': require('./SpriteBatch.js'),
9 | 'Texture': require('./Texture.js'),
10 | 'TextureRegion': require('./TextureRegion.js'),
11 | 'WebGLContext': require('./WebGLContext.js'),
12 | 'FrameBuffer': require('./glutils/FrameBuffer.js'),
13 | 'Mesh': require('./glutils/Mesh.js'),
14 | 'ShaderProgram': require('./glutils/ShaderProgram.js')
15 | };
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "kami",
3 | "version": "0.5.3",
4 | "description": "WebGL utilities for performant and flexible 2D and 3D rendering.",
5 | "main": "lib/index.js",
6 | "scripts": {
7 | "test": "echo \"Error: no test specified\" && exit 1"
8 | },
9 | "author": "",
10 | "license": "MIT",
11 | "dependencies": {
12 | "signals": "~1.0.0",
13 | "klasse": "~1.0.6",
14 | "number-util": "~1.0.1"
15 | },
16 | "repository": {
17 | "type": "git",
18 | "url": "https://github.com/mattdesl/kami.git"
19 | },
20 | "devDependencies": {
21 | "grunt": "~0.4.1",
22 | "browserify": "~2.35.0",
23 | "grunt-browserify": "~1.2.9",
24 | "grunt-contrib-watch": "~0.5.3",
25 | "load-grunt-tasks": "~0.2.0",
26 | "grunt-contrib-yuidoc": "~0.5.0",
27 | "grunt-contrib-uglify": "~0.2.5",
28 | "grunt-autoindex": "~0.1.1"
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
