Scaleform Studio Lua API Reference: scaleform.BitmapComponent object reference
scaleform.BitmapComponent object reference
Description
An interface to bitmap component.
Inheritance 
Constructors and accessors
Related help topics
Functions
Parameters
Returns
owner : |
The actor parent of the newly created layout. |
|
A handle to the newly create bitmap component. |
Parameters
Returns
self : |
The bitmap to get the image resource from. |
lightuserdata |
The image resource. |
Parameters
Returns
self : |
The bitmap to load. | |
filename : | string |
The name of the file to load the bitmap from. |
async : | boolean? |
True for asynchronous loading. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
boolean |
Whether the bitmap was loaded or not. |
scaleform.ComponentThe root type of all actor components.
scaleform.VisualComponentAn interface to the visual component.
scaleform.BitmapComponent.create (owner) : scaleform.BitmapComponentCreates a bitmap component for the actor.
owner : scaleform.ActorThe actor parent of the newly created layout.
scaleform.BitmapComponentA handle to the newly create bitmap component.
scaleform.ActorGeneric objects located in a scene.
scaleform.BitmapComponentAn interface to bitmap component.
scaleform.BitmapComponent.image_resource (self) : lightuserdataReturns the image resource set as the bitmap.
self : scaleform.BitmapComponentThe bitmap to get the image resource from.
lightuserdataA pointer to a memory block that is allocated and maintained in C. scaleform.BitmapComponent.load (self, filename, async) : booleanLoads a bitmap from file.
self : scaleform.BitmapComponentThe bitmap to load.
filename : stringThe name of the file to load the bitmap from.
async : boolean?True for asynchronous loading.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
booleanA string of characters.true or false. scaleform.BitmapComponent.set_image_resource (self, imageRes) Sets an image resource to use as bitmap.
self : scaleform.BitmapComponentThe bitmap to set the image resource on.
imageRes : lightuserdataThe image resource to use for the bitmap.Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.