GPUBuffer Class Reference

Buffer abstraction. More...

Inheritance diagram for GPUBuffer:

Classes
class	CreateInfo
	CreateInfo The create info for creating a GPUBuffer. More...

Static Public Member Functions
static ObjectRef< GPUBuffer >	create (Domain domain, GPUBuffer.CreateInfo createInfo, String name)
	Creates a GPUBuffer.

Static Public Attributes
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 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< TType >	tryCreateObjectRef (Class< TType > clazz)
	Tries to create an owning ObjectRef instance to this KanziObject.
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 GPUBufferMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.GPUBuffer")
	Metaclass for GPUBuffer.

Detailed Description

Buffer abstraction.

Member Function Documentation

create()

static ObjectRef< GPUBuffer > create ( Domain domain, GPUBuffer.CreateInfo createInfo, String name )

static

Creates a GPUBuffer.

Parameters

domain
createInfo
name

Precondition

If createInfo.handle is valid createInfo.usage must match the usage createInfo.handle was created with.

If createInfo.handle is valid createInfo.cpuAccess must match the access handle was created with.

If createInfo.handle is valid createInfo.size must match the size handle was created with.

If createInfo.handle is valid, createInfo.initialData must be empty.

createInfo.size must not be 0, unless createInfo.initialData is non-empty, in which case the buffer is sized to the initial data.

The resulting buffer size must not be greater than the maximum value of a uint32_t.

If createInfo.size is not 0, the size of createInfo.initialData must be less than or equal to createInfo.size.

If createInfo.format is not gfx.Format.None and is an uncompressed format, the resulting buffer size must be a multiple of the stride of createInfo.format.

If createInfo.format is not gfx.Format.None and is a compressed format, the resulting buffer size must be a multiple of the block stride of createInfo.format.

Postcondition

If createInfo.size is 0, the buffer size equals the size of createInfo.initialData.

Member Data Documentation

metaclass

final Metaclass metaclass

static

Initial value:

=
        com.rightware.kanzi.metadata.GPUBufferMetadata.metaclass

The Metaclass for the class.