Texture Class Reference
A Texture provides an image that you can use in Image nodes, Texture Brushes, materials for use in 3D rendering, or Material Brushes. More...
Inheritance diagram for Texture:
Public Member Functions | |
| void | close () |
| Closes the texture resource. | |
| long | getFaceCount () |
| Returns the face count of this texture. | |
| GraphicsFormat | getFormat () |
| Returns the GraphicsFormat of this texture. | |
| long | getGPUMemoryUsage () |
| Returns the GPUMemoryUsage of this texture. | |
| long | getHeight () |
| Returns the height of this texture. | |
| long | getMipmapLevelCount () |
| Returns the mipmap level count of this texture. | |
| long | getSliceCount () |
| Returns the slice count of this texture. | |
| long | getWidth () |
| Returns the width of this texture. | |
| boolean | isDeployed () |
| Returns whether the texture is deployed or not. | |
 Public Member Functions inherited from Resource | |
| String | getName () |
| Gets the resource name. | |
| String | getUrl () |
| Gets the resource URL. | |
| void | setKeepAlive (boolean keepAlive) |
| Sets the keep alive flag. | |
| Public Member Functions inherited from KanziObject | |
| boolean | equals (Object object) |
| Domain | getDomain () |
| Returns the domain the object belongs to. | |
| Metaclass | getDynamicMetaclass () |
| Returns the metaclass of the dynamic type of the object. | |
| long | getNative () |
| Gets a pointer to the backing C++ instance. | |
| TDataType | getOptionalProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type, but does not use the default value if there are no inputs to the property value. | |
| TDataType | getProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type. | |
| int | hashCode () |
| boolean | hasValue (PropertyType< TDataType > propertyType) |
| Evaluates whether there are any inputs into the property value. | |
| boolean | isStale () |
| Test if the object is stale i.e. | |
| void | removeLocalValue (PropertyType< TDataType > propertyType) |
| Removes the local value associated with the property. | |
| void | setFlagKeepDuringPatching (PropertyType< TDataType > propertyType) |
| Sets the flag to indicate that the property was loaded from KZB. | |
| void | setProperty (PropertyType< TDataType > propertyType, TDataType value) |
| Sets the local value of a property type. | |
| ObjectRef< TType > | tryCreateObjectRef (Class< TType > clazz) |
| Tries to create an owning ObjectRef instance to this KanziObject. | |
Static Public Attributes | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from Resource | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from KanziObject | |
| static final Metaclass | metaclass = new AbstractMetaclass("Kanzi.Object") |
| The Metaclass for the class. | |
Additional Inherited Members | |
| Public Attributes inherited from ResourceMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Resource") |
| Metaclass for Resource. | |
| Public Attributes inherited from TextureMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Texture") |
| Metaclass for Texture. | |
| Public Attributes inherited from SurfaceMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Surface") |
| Metaclass for Surface. | |
| Public Attributes inherited from GPUResourceMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.GPUResource") |
| Metaclass for GPUResource. | |
Detailed Description
A Texture provides an image that you can use in Image nodes, Texture Brushes, materials for use in 3D rendering, or Material Brushes.
You can set textures as a render target for either a 2D node or a render pass, but not both.
To create a Texture, use com.rightware.kanzi.TextureBuilder.
Member Function Documentation
◆ getFaceCount()
| long getFaceCount | ( | ) |
Returns the face count of this texture.
- Returns
- The texture's face count.
◆ getFormat()
| GraphicsFormat getFormat | ( | ) |
Returns the GraphicsFormat of this texture.
- Returns
- The texture's GraphicsFormat.
◆ getGPUMemoryUsage()
| long getGPUMemoryUsage | ( | ) |
Returns the GPUMemoryUsage of this texture.
- Returns
- The texture's GPUMemoryUsage.
◆ getHeight()
| long getHeight | ( | ) |
Returns the height of this texture.
- Returns
- The texture's height.
◆ getMipmapLevelCount()
| long getMipmapLevelCount | ( | ) |
Returns the mipmap level count of this texture.
- Returns
- The texture's mipmap level count.
◆ getSliceCount()
| long getSliceCount | ( | ) |
Returns the slice count of this texture.
- Returns
- The texture's slice count.
◆ getWidth()
| long getWidth | ( | ) |
Returns the width of this texture.
- Returns
- The texture's width.
◆ isDeployed()
| boolean isDeployed | ( | ) |
Returns whether the texture is deployed or not.
- Returns
- The boolean indicating the texture's deployment status.