phaser/resources/docgen/output/PIXI.BaseTexture.json

{"class":{"name":"PIXI.BaseTexture","extends":"","static":false,"constructor":true,"parameters":[{"name":"source","type":["string"],"help":"the source object (image or canvas)","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"help":"A texture stores the information that represents an image. All textures have a base texture."},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys this base texture","line":156,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"dirty","static":false,"returns":null,"help":"Sets all glTextures to be dirty.","line":204,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"fromCanvas","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a base texture from the given canvas element.","line":263,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["PIXI.Canvas"],"help":"The canvas element source of the texture","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"fromImage","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a base texture from the given image url.\\nIf the image is not in the base texture cache it will be created and loaded.","line":223,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageUrl","type":["string"],"help":"The image url of the texture","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateSourceImage","static":false,"returns":null,"help":"Changes the source image of the texture","line":192,"public":true,"protected":false,"private":false,"parameters":[{"name":"newSrc","type":["string"],"help":"the path of the image","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"hasLoaded","type":["boolean"],"help":"[read-only] Set to true once the base texture has loaded","inlineHelp":"","line":62,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"height","type":["number"],"help":"[read-only] The height of the base texture set when the image has loaded","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"imageUrl","type":["string"],"help":"","inlineHelp":"","line":136,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"premultipliedAlpha","type":["boolean"],"help":"Controls if RGB channels should be pre-multiplied by Alpha  (WebGL only)","inlineHelp":"","line":81,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The Resolution of the texture.","inlineHelp":"","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scaleMode","type":["PIXI.scaleModes"],"help":"The scale mode to apply when scaling this texture","inlineHelp":"","line":53,"default":"PIXI.scaleModes.LINEAR","public":true,"protected":false,"private":false,"readOnly":false},{"name":"source","type":["Image"],"help":"The image source that is used to create the texture.","inlineHelp":"","line":70,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"[read-only] The width of the base texture set when the image has loaded","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"_dirty","type":["array"],"help":"","inlineHelp":"","line":100,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_glTextures","type":["array"],"help":"","inlineHelp":"","line":90,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_powerOf2","type":["boolean"],"help":"","inlineHelp":"","line":143,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}