Kanzi 4.1.0
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.
 
- Public Member Functions inherited from Surface
int getFaceCount ()
 Get number of faces.
 
GraphicsFormat getFormat ()
 Get GraphicsFormat of Surface.
 
int getHeight ()
 Get height in pixels.
 
int getMipmapLevelCount ()
 Get number of mipmap levels.
 
int getRenderTargetSampleCount ()
 Get number of multisample samples for Surface.
 
int getSliceCount ()
 Get number of slices.
 
int getWidth ()
 Get width in pixels.
 
- Public Member Functions inherited from GPUResource
int getGPUMemoryUsage ()
 Gets the amount of GPU memory used by the resource.
 
boolean isDeployed ()
 
- Public Member Functions inherited from ResourceProxy
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< TTypetryCreateObjectRef (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 Surface
static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from GPUResource
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 ResourceProxy
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 GPUResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.GPUResource")
 Metaclass for GPUResource.
 
- Public Attributes inherited from SurfaceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Surface")
 Metaclass for Surface.
 
- Public Attributes inherited from TextureMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Texture")
 Metaclass for Texture.
 

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 Data Documentation

◆ metaclass

final Metaclass metaclass
static
Initial value:
=
com.rightware.kanzi.metadata.TextureMetadata.metaclass

The Metaclass for the class.