Class Index | File Index

Classes


Class Karma.karma

This object stores the global settings for the Karma library
Defined in: karma.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Stores global settings for the Karma library
Field Summary
Field Attributes Field Name and Description
<static>  
Karma.karma.audio
Collection of audio files with special helper methods added to each reference
<static>  
Karma.karma.canvas
Collection of html 5 canvases with special helper methods added to each reference
<static>  
Karma.karma.image
Collection of images with special helper methods added to each reference
<static>  
Karma.karma.locale
This is the global locale as passed to Karma(), such as "en", "es_SP"
<static>  
Karma.karma.svg
Collection of svgs with special helper methods added to each reference
<static>  
Karma.karma.video
Collection of videos with special helper methods added to each reference
Method Summary
Method Attributes Method Name and Description
<static>  
Karma.karma.ready(cb)
Waits until all assets loaded(ready), then calls callback cb
Class Detail
Karma.karma()
Stores global settings for the Karma library
Field Detail
<static> {object} Karma.karma.audio
Collection of audio files with special helper methods added to each reference
Default Value:
empty object

<static> {object} Karma.karma.canvas
Collection of html 5 canvases with special helper methods added to each reference
Default Value:
empty object

<static> {object} Karma.karma.image
Collection of images with special helper methods added to each reference
Default Value:
empty object

<static> Karma.karma.locale
This is the global locale as passed to Karma(), such as "en", "es_SP"
Default Value:
undefined

<static> {object} Karma.karma.svg
Collection of svgs with special helper methods added to each reference
Default Value:
empty object

<static> {object} Karma.karma.video
Collection of videos with special helper methods added to each reference
Default Value:
empty object
Method Detail
<static> Karma.karma.ready(cb)
Waits until all assets loaded(ready), then calls callback cb
var k = Karma({ . . . your assets here . . . });
k.ready(function(){ .. your code here . . .});

your code will not be called until all assets have been loaded
into collections
Parameters:
{Function} cb Optional
callback function
Throws:
{Error}
if Karma.karma is not initialized with the Karma({ options }) function
Returns:
this

Documentation generated by JsDoc Toolkit 2.3.2 on Tue Jan 05 2010 09:40:17 GMT+0545 (NPT)