{ "version": "1.0.0", "metadata": { "linker": "(unsigned)", "siteDomain": "https://webdoc-labs.github.io", "siteRoot": "example-documentation" }, "root": { "id": "root-u2RJw_Fpcmmv3mHVc769j", "name": "", "type": "RootDoc", "members": [ { "id": "D3hEunKBUuF1R-t7J5LKb", "name": "PIXI", "brief": "", "type": "NSDoc", "members": [ { "id": "OR8UCEQZ_FNtfZyqWC4q4", "name": "utils", "brief": "", "defaultValue": "false", "scope": "static", "type": "NSDoc", "members": [ { "id": "ws4t9aWL37ZkoUhwjiSU8", "name": "skipHello", "brief": "
Skips the hello message of renderers that are created after this is run.
", "deprecated": true, "type": "FunctionDoc", "params": [], "returns": [ { "dataType": { "tokens": [ { "value": "void", "kind": "canonical" } ], "template": "void" } } ] } ] }, { "id": "tQCPbrBuwwwm7-FrXpvtJ", "name": "TilingSprite", "brief": "", "deprecated": "since 5.0.0", "scope": "static", "see": [ "PIXI.TilingSprite" ], "type": "ClassDoc", "members": [ { "id": "HeCWlTR_PqjrLEa_33d_-", "name": "constructor", "brief": "", "access": "public", "scope": "instance", "type": "MethodDoc" } ] }, { "id": "az0hvzrL8WU6GACZHtSuH", "name": "AbstractRenderer", "brief": "", "type": "ClassDoc", "members": [ { "id": "9ktCYQDmZmJlffGXsKPxj", "name": "backgroundColor", "brief": "The background color to fill if not transparent
", "scope": "instance", "type": "PropertyDoc" }, { "id": "DF316xUJo0SRAqPm8Xpxv", "name": "constructor", "brief": "", "access": "public", "scope": "instance", "type": "MethodDoc" } ] }, { "id": "nN-gN3WCYB3WfOXc0oNy4", "name": "ObjectRenderer", "brief": "Base for a common object renderer that can be used as a system renderer plugin.
", "type": "ClassDoc", "extends": [ "PIXI.System" ], "members": [ { "id": "o-accggKf0jCzbjHlsfKN", "name": "renderer", "brief": "The renderer this manager works for.
", "scope": "instance", "type": "PropertyDoc" }, { "id": "GpufYcQJsda3qXmJke3DR", "name": "constructor", "brief": "", "scope": "instance", "type": "MethodDoc", "params": [ { "identifier": "renderer", "optional": false, "description": "The renderer this manager works for.
", "dataType": { "tokens": [ { "value": "PIXI.Renderer", "kind": "canonical" }, { "value": "PIXI.Renderer", "kind": "canonical" } ], "template": "%1" } } ], "returns": [] }, { "id": "xo9hNW194xJZjsW3LlaGe", "name": "destroy", "brief": "", "scope": "instance", "type": "MethodDoc", "description": "Generic destruction method that frees all resources. This\nshould be called by subclasses.
", "params": [], "returns": [] }, { "id": "5O97ZazYxFRXcmTqymoqy", "name": "flush", "brief": "", "scope": "instance", "type": "MethodDoc", "description": "Stub method that should be used to empty the current\nbatch by rendering objects now.
", "params": [], "returns": [] }, { "id": "Uh7dKFPgIO3qXnOBcnItv", "name": "render", "brief": "", "scope": "instance", "type": "MethodDoc", "description": "Keeps the object to render. It doesn't have to be\nrendered immediately.
", "params": [ { "identifier": "object", "optional": false, "description": "The object to render.
", "dataType": { "tokens": [ { "value": "PIXI.DisplayObject", "kind": "canonical" }, { "value": "PIXI.DisplayObject", "kind": "canonical" } ], "template": "%1" } } ], "returns": [] }, { "id": "t7VAmlgtQF3Byj5ZfqBIK", "name": "start", "brief": "", "scope": "instance", "type": "MethodDoc", "description": "Stub method that initializes any state required before\nrendering starts. It is different from the prerender\ns...",
"params": [],
"returns": []
},
{
"id": "sEGq-h5h8E7blm1eUBti4",
"name": "stop",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "
Stops the renderer. It should free up any state and\nbecome dormant.
", "params": [], "returns": [] } ] }, { "id": "aXAUk5Nw6XkTuEP5aBrq5", "name": "System", "brief": "System is a base class used for extending systems used by the {@link PIXI.AbstractRenderer}.
", "see": [ "PIXI.Renderer#addSystem" ], "type": "ClassDoc", "description": "Search more here: {@link https://www.google.com/}
", "members": [ { "id": "DVZ3ghCgUiLX6bDmaZVVm", "name": "renderer", "brief": "The renderer this manager works for.
", "scope": "instance", "type": "PropertyDoc" }, { "id": "fQ_NBScmh5qy2OUQ9G-0G", "name": "constructor", "brief": "", "scope": "instance", "type": "MethodDoc", "params": [ { "identifier": "renderer", "optional": false, "description": "The renderer this manager works for.
", "dataType": { "tokens": [ { "value": "PIXI.Renderer", "kind": "canonical" }, { "value": "PIXI.Renderer", "kind": "canonical" } ], "template": "%1" } } ], "returns": [] }, { "id": "MKPPtvpdc6ULhkgYfs2Hr", "name": "destroy", "brief": "Generic destroy methods to be overridden by the subclass
", "scope": "instance", "type": "MethodDoc", "params": [], "returns": [] } ] }, { "id": "LO7y8dUdFIKttfI5lVvsf", "name": "AbstractBatchRenderer", "brief": "Renderer dedicated to drawing and batching sprites.
", "access": "protected", "readonly": true, "type": "ClassDoc", "description": "This is the default batch renderer. It buffers objects\nwith texture-based geometries and renders them in\nbatches. It uploa...", "extends": [ "PIXI.ObjectRenderer" ], "members": [ { "id": "jHLcvgQ53DRDUAfgy8yMU", "name": "_drawCallPool", "brief": "", "scope": "static", "type": "PropertyDoc", "description": "
Pool of BatchDrawCall objects that flush used\nto create "batches" of the objects being..."
},
{
"id": "ZgEt7hm9BuCOKpGuWf7gh",
"name": "_textureArrayPool",
"brief": "",
"scope": "static",
"type": "PropertyDoc",
"description": "
Pool of BatchDrawCall objects that flush used\nto create "batches" of the objects being..."
},
{
"id": "UFcmhtkJkewXExA8sPo5x",
"name": "bufferSize",
"brief": "",
"scope": "instance",
"type": "PropertyDoc"
},
{
"id": "Ji6GmTq1aGM7MgvMIQXSW",
"name": "MAX_TEXTURES",
"brief": "",
"defaultValue": "1",
"readonly": true,
"scope": "instance",
"see": [
"PIXI.AbstractBatchRenderer#contextChange"
],
"type": "PropertyDoc",
"description": "
Maximum number of textures that can be uploaded to\nthe GPU under the current context. It is initialized\nproperly in The renderer this manager works for. The number of bufferable objects before a flush\noccurs automatically. The WebGL state in which this renderer will work. Size of data being buffered per vertex in the\nattribute buffers (in floats). By default, the\nbatch-renderer plugin uses 6:..."
},
{
"id": "js5F-ZgclEdVsPJYpCE_C",
"name": "_shader",
"brief": " This shader is generated by It is generated specifically to handle the required\nnumber of textures being batched together. The class that represents the geometry of objects\nthat are going to be batched with this. This is used to generate a shader that can\ncolor each vertex based on a Pool of Buffer of objects that are yet to be rendered. Data for texture batch builder, helps to save a bit of CPU on a pass Number of elements that are buffered and are\nwaiting to be flushed. A flush may occur multiple times in a single\nframe. On iOS devices or when\n Pool of Total count of all indices used by the currently\nbuffered objects. Pool of Size of Total count of all vertices used by the currently\nbuffered objects. Bind textures for current rendering Populating drawcalls for rendering This will hook onto the renderer's The renderer this works for. Handles the It calculates Destroys this Renders the content now and empties the current batch. Makes sure that static and dynamic flush pooled objects have correct dimensions Handles the It ensures that flushes start from the first geometry\nobject again. Takes the four batching parameters of element being rendered attribute buffer. index buffer number of floats already in the attribute buffer number of indices already in Buffers the "batchable" object. It need not be rendered\nimmediately. the element to render when\nusing this renderer Starts a new sprite batch. Stops and flushes the current batch. Fetches an attribute buffer from minimum capacity required Fetches an index buffer from minimum required capacity Called when destroying Application, scoped to Application instance Called when Application is constructed, scoped to Application instance.\nPasses in Constants that specify the transform type. A namespace dedicated to road manipulation utilites. This is another road class. This is another road class. The default no. of lanes per one side of road Builds a road Bean class Bean class (optional) roasting method Simulation for a automobile that can drive on a manifold surface. The mesh enclosing this object. By default, it is a "point" object at the its own\nposition. All causal interactions with other objects The mass of this object in kilograms. The absolute position of this object's center of mass (in the universal reference frame) The absolute velocity of this object (in the universal reference frame) Register a retail dealer for buying a car from Simulation for a automobile that can drive on a manifold surface. This class illustrates how you can create a Java-bean like component in JavaScript whether the bean is Roast this coffee bean. NOTE: You cannot re-roast coffee beans and an error will be thrown if you try to\nroast a roasted coffee bean. {@link ExampleFactory} can be used to build examples. A custom context for the factory. Gets a lazily-initialized, shared singleton instance of {@link ExampleFactory}. Build the road. This constructor should only be used for custom contexts. A custom context for the factory. Get the context of this factory. This class shouldn't be documented! This class shouldn't be documented! This method should be overriden to calculate the force at the given instant. A physical interaction is a force causes object positions to be re-evaulated each frame based on\nforce's magnitude. Creates a graviational force This method should be overriden to calculate the force at the given instant. Represents a physical-object and its intrinsic properties. This is useful for approximating\nextended objects as a uniform,...",
"members": [
{
"id": "LXwNc7tALjWOkKLCAKVk1",
"name": "bounds",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": " The mesh enclosing this object. By default, it is a "point" object at the its own\nposition. All causal interactions with other objects The mass of this object in kilograms. The absolute position of this object's center of mass (in the universal reference frame) The absolute velocity of this object (in the universal reference frame) The no. of components of this vector Add Whether this and Whether this and These are the possible types of car makes. toyota make A 3D vector This is the interface for dealing with car dealers. Close transaction. If you respond to the counteroffer, then it won't be closed. Initiate a transaction/negotiation with a car dealer info Offer a price to sell the car. NOTE: This is invalid behaviour if you are the buyer in the transaction. type inference is working Offer a price to buy the car. NOTE: This is invalid behaviour if you are the seller in the transaction. Install a bean class the bean class Checks whether the object is an instance of {@code PhysicalObject}...."
},
{
"id": "WdPooO9xC3Bkz4UJJ2yPG",
"name": "renderer",
"brief": "this.shaderGenerator.aTextureId\nattribute that points to a..."
},
{
"id": "lda_v86Kl80TEdOUIsqhh",
"name": "_aBuffers",
"brief": "",
"access": "private",
"scope": "instance",
"see": [
"PIXI.AbstractBatchRenderer#getAttributeBuffer"
],
"type": "PropertyDoc",
"description": "ViewableBuffer objects that are sorted in\norder of increasing size. The flush method uses\nthe buffer ..."
},
{
"id": "XHM-fCFAb6AQVZ7fFWxIw",
"name": "_bufferedElements",
"brief": "settings.CAN_UPLOAD_SAME_BUFFER is..."
},
{
"id": "O6J92GQMCt_nKu3jShBi-",
"name": "_iBuffers",
"brief": "",
"access": "private",
"scope": "instance",
"see": [
"PIXI.AbstractBatchRenderer#getIndexBuffer"
],
"type": "PropertyDoc",
"description": "Uint16Array objects that are sorted in\norder of increasing size. The flush method uses\nthe buffer wit..."
},
{
"id": "qNxkp3EdzUjVv18yiOXEs",
"name": "_indexCount",
"brief": "",
"access": "private",
"defaultValue": "0",
"scope": "instance",
"type": "PropertyDoc",
"description": "this.geometryClass geometry objects\nthat store buffers. They are used to pass data\nto the shader on e..."
},
{
"id": "mGQQ6OIJt58rNZQyR_Z2k",
"name": "_packedGeometryPoolSize",
"brief": "",
"access": "private",
"defaultValue": "2",
"scope": "instance",
"type": "PropertyDoc",
"description": "this._packedGeometries. It can be expanded\nif more than this._packedGeometryPoolSize flu..."
},
{
"id": "fq3y471VvnHsARZ53ozon",
"name": "_vertexCount",
"brief": "",
"access": "private",
"defaultValue": "0",
"scope": "instance",
"type": "PropertyDoc",
"description": "contextChange\nand prerender signals.contextChange signal.this.MAX_TEXTURES and allocating the\npacked-geometry object pool.AbstractBatchRenderer. It cannot be used again.prerender signal.element, interleaves\nand pushes them into the batching attribute/index ...",
"params": [
{
"identifier": "element",
"optional": false,
"description": "indexBufferthis._aBuffers that\ncan hold atleast size floats.\n
",
"dataType": {
"tokens": [
{
"value": "ViewableBuffer",
"kind": "canonical"
},
{
"value": "ViewableBuffer",
"kind": "canonical"
}
],
"template": "%1"
}
}
]
},
{
"id": "0er-x1LWCmdDTeuqxrMIW",
"name": "getIndexBuffer",
"brief": "",
"access": "private",
"scope": "instance",
"type": "MethodDoc",
"description": "size floatsthis._iBuffers that can\nhas atleast size capacity.\n
",
"dataType": {
"tokens": [
{
"value": "Uint16Array",
"kind": "canonical"
},
{
"value": "Uint16Array",
"kind": "canonical"
}
],
"template": "%1"
}
}
]
}
]
},
{
"id": "o-fPV5rM3AxrWx849nTzA",
"name": "",
"brief": "",
"type": "TypedefDoc",
"extends": [],
"members": [
{
"id": "75XreK847raoclsm7xING",
"name": "destroy",
"brief": "",
"access": "public",
"scope": "static",
"type": "PropertyDoc",
"description": "size\nindices.options as the only argumen..."
}
]
},
{
"id": "oWgPTPzz3NH3hUr3ne5ux",
"name": "SVG_SIZE",
"brief": "",
"deprecated": "since 5.0.0",
"scope": "static",
"see": [
"PIXI.resources.SVGResource.SVG_SIZE"
],
"type": "PropertyDoc"
},
{
"id": "_Lc40ibTChqYzZTvtfylM",
"name": "TRANSFORM_MODE",
"brief": "const car = new Car({...",
"extends": [
"PhysicalObject"
],
"members": [
{
"id": "fhd_-xmLIGBh7_vuA_4lV",
"name": "DEFAULT_DRIVE_SHIFT",
"brief": "",
"defaultValue": "\"manual\"",
"scope": "static",
"type": "PropertyDoc"
},
{
"id": "78_dshuJQOMES8t9D7PUy",
"name": "bounds",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "roasted/...",
"params": [
{
"identifier": "context",
"optional": true,
"default": "null",
"description": "vec to thisvec are equal vectorsvec are compatible vectors (same dimensions)