Kanzi  3.9.9
Kanzi Engine Java API
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:
[legend]

Public Member Functions

void close ()
 Closes the texture resource.
 
long getFaceCount ()
 Returns the face count of this texture. More...
 
GraphicsFormat getFormat ()
 Returns the GraphicsFormat of this texture. More...
 
long getGPUMemoryUsage ()
 Returns the GPUMemoryUsage of this texture. More...
 
long getHeight ()
 Returns the height of this texture. More...
 
long getMipmapLevelCount ()
 Returns the mipmap level count of this texture. More...
 
long getSliceCount ()
 Returns the slice count of this texture. More...
 
long getWidth ()
 Returns the width of this texture. More...
 
boolean isDeployed ()
 Returns whether the texture is deployed or not. More...
 
- Public Member Functions inherited from Resource
String getName ()
 Gets the resource name. More...
 
String getUrl ()
 Gets the resource URL. More...
 
void setKeepAlive (boolean keepAlive)
 Sets the keep alive flag. More...
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to. More...
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object. More...
 
long getNative ()
 Gets a pointer to the backing C++ instance. More...
 
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. More...
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type. More...
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value. More...
 
boolean isStale ()
 Test if the object is stale i.e. More...
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property. More...
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type. More...
 
ObjectRef< TType > tryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject. More...
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from Resource
static final Metaclass metaclass
 The Metaclass for the class. More...
 
- 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 TextureBuilder.

Member Function Documentation

long getFaceCount ( )

Returns the face count of this texture.

Returns
The texture's face count.
GraphicsFormat getFormat ( )

Returns the GraphicsFormat of this texture.

Returns
The texture's GraphicsFormat.
long getGPUMemoryUsage ( )

Returns the GPUMemoryUsage of this texture.

Returns
The texture's GPUMemoryUsage.
long getHeight ( )

Returns the height of this texture.

Returns
The texture's height.
long getMipmapLevelCount ( )

Returns the mipmap level count of this texture.

Returns
The texture's mipmap level count.
long getSliceCount ( )

Returns the slice count of this texture.

Returns
The texture's slice count.
long getWidth ( )

Returns the width of this texture.

Returns
The texture's width.
boolean isDeployed ( )

Returns whether the texture is deployed or not.

Returns
The boolean indicating the texture's deployment status.

Member Data Documentation

final Metaclass metaclass
static
Initial value:

The Metaclass for the class.