Unigine::MeshDynamic Class

MeshDynamic Class

枚举

BUFFER#

Name	描述
USAGE_IMMUTABLE_VERTEX = 1 << 0	Vertex buffer will be created in GPU memory as an unmodifiable resource.
USAGE_IMMUTABLE_INDICES = 1 << 1	Index buffer will be created in GPU memory as an unmodifiable resource.
USAGE_IMMUTABLE_ALL = (USAGE_IMMUTABLE_VERTEX | USAGE_IMMUTABLE_INDICES)	Vertex and index buffers will be created in GPU memory as unmodifiable resources.
USAGE_DYNAMIC_VERTEX = 1 << 2	Vertex buffer will be created in GPU memory as a dynamic resource.
USAGE_DYNAMIC_INDICES = 1 << 3	Index buffer will be created in GPU memory as a dynamic resource.
USAGE_DYNAMIC_ALL = (USAGE_DYNAMIC_VERTEX | USAGE_DYNAMIC_INDICES)	Vertex and index buffers will be created in GPU memory as dynamic resources.
USAGE_FLUSH_VERTEX = 1 << 4	Data on updated vertices will be sent from CPU to GPU.
USAGE_FLUSH_INDICES = 1 << 5	Data on updated indices will be sent from CPU to GPU.
USAGE_FLUSH_ALL = (USAGE_FLUSH_VERTEX | USAGE_FLUSH_INDICES)	Data on updated vertices and indices will be sent from CPU to GPU.
USAGE_MISC_SHARED = 1 << 6	Data is accessible by an external graphics API (applicable for DX12 and Vulkan only).

TYPE#

Name	描述
TYPE_HALF = 0	Half-precision floating-point data type.
TYPE_FLOAT = 1	Floating-point data type.
TYPE_UCHAR = 2	Unsigned character data type.
TYPE_USHORT = 3	Unsigned short data type.
NUM_TYPES = 4	Number of data types.

MODE#

Name	描述
MODE_POINTS = 0	Mode to render the points.
MODE_LINES = 1	Mode to render the lines.
MODE_TRIANGLES = 2	Mode to render the triangles.
MODE_TRIANGLE_PATCHES = 3	Mode to render the triangle patches.
MODE_QUAD_PATCHES = 4	Mode to render the quad patches.
NUM_MODES = 5	Number of rendering modes.

Members

void setFlags ( int flags ) #

Arguments

• int flags - The creation flags. A combination of USAGE_IMMUTABLE_*, USAGE_DYNAMIC_* and USAGE_FLUSH_* flags.

int getFlags() const#

Return value

Current creation flags. A combination of USAGE_IMMUTABLE_*, USAGE_DYNAMIC_* and USAGE_FLUSH_* flags.

bool isUsageShared() const#

Return value

true if the USAGE_MISC_SHARED flag for Mesh Dynamic is enabled; otherwise false.

---

Ptr<MeshDynamic> create ( int flags ) #

Creates a new dynamic mesh instance in accordance with the specified flags.

Arguments

• int flags - Creation flags. A combination of USAGE_IMMUTABLE_*, USAGE_DYNAMIC_* and USAGE_FLUSH_* flags.

Return value

MeshDynamic smart pointer.

bool copy ( const Ptr<MeshDynamic> & dest ) const#

Copies the dynamic mesh to the specified target.

Arguments

• const Ptr<MeshDynamic> & dest - Target dynamic mesh to which the mesh is to be copied.

Return value

true if the dynamic mesh is copied successfully to the specified target; otherwise, false.

void bind ( ) #

Binds dynamic mesh data (index and vertex buffers) to the input assembler stage.

void unbind ( ) #

Unbinds dynamic mesh data (index and vertex buffers).

void flushVertex ( ) #

Flushes the vertex buffer and sends all data to GPU. This method is called automatically, if the length of the vertex buffer changes. If you change the contents of the vertex buffer, you should call this method.

void flushIndices ( ) #

Flushes the index buffer and sends all data to GPU. This method is called automatically, if the length of the index buffer changes. If you change the contents of the index buffers, you should call this method.

int renderSurface ( int mode ) #

Renders the surface.

Arguments

• int mode - Rendering mode. One of the MODE values.

Return value

Number of primitives rendered. Primitive type is determined by the rendering mode.

int renderInstancedSurface ( int mode, int num ) #

Renders the specified number of instances of the surface.

Arguments

• int mode - Rendering mode. One of the MODE values.
• int num - Number of instances to be rendered.

Return value

Number of primitives rendered. Primitive type is determined by the rendering mode.

int renderSurface ( int mode, int base, int begin, int end ) #

Renders the surface specified by begin and end indices.

Arguments

• int mode - Rendering mode. One of the MODE values.
• int base - A value added to each index before reading a vertex from the vertex buffer.
• int begin - First index of the surface to be read by the GPU from the index buffer.
• int end - Last index of the surface to be read by the GPU from the index buffer.

Return value

Number of primitives rendered. Primitive type is determined by the rendering mode.

int renderInstancedSurface ( int mode, int base, int begin, int end, int num ) #

Renders the specified number of instances of the surface specified by begin and end indices.

Arguments

• int mode - Rendering mode. One of the MODE values.
• int base - A value added to each index before reading a vertex from the vertex buffer.
• int begin - First index of the surface to be read by the GPU from the index buffer.
• int end - Last index of the surface to be read by the GPU from the index buffer.
• int num - Number of instances to be rendered.

Return value

Number of primitives rendered. Primitive tyme is determined by the rendering mode.

int render ( int mode, int flush ) #

Renders the dynamic mesh with the specified flags and mode.

Arguments

• int mode - Rendering mode. One of the MODE values.
• int flush - Flush flag. One of the USAGE_FLUSH_* variables.

Return value

Number of triangles rendered.

long long getSystemMemoryUsage ( ) #

Returns the current amount of system memory used by the dynamic mesh, in bytes.

Return value

System memory amount used by the dynamic mesh, in bytes.

long long getVideoMemoryUsage ( ) #

Returns the current amount of video memory used by the dynamic mesh.

Return value

Video memory amount used by the dynamic mesh, in bytes.

void setVertexFormat ( const MeshDynamic::Attribute[] & attributes ) #

Sets vertex format to be used by the dynamic mesh.

Arguments

• const MeshDynamic::Attribute[] & attributes - Array of attributes to be used for vertex format, can be up to 16 attributes for one vertex. The numeration starts from 0. Each attribute consists of:
  • An offset of the vertex in bytes, depends on the vertex type and size.
  • Type of the vertex: one of the TYPE_* values
  • Size of the vertex: can be 1,2,3,4 for float type; 2,4 for half type; 4 for UChar type
    Notice

    When it goes to shader, 0 -attribute always comes with the size of 4, no matter what size is specified in the method. All the other attributes come with the specified sizes.

int getVertexSize ( ) const#

Returns vertex size of the dynamic mesh.

Return value

Vertex size.

int getNumAttributes ( ) const#

Returns the number of vertex attributes of the dynamic mesh.

void clearVertex ( ) #

Removes all dynamic mesh vertices.

void allocateVertex ( int num ) #

Allocates a given number of vertices in the vertex buffer. With this function, memory can be allocated once rather than in chunks, making the creation faster.

Arguments

• int num - Number of vertices for which memory is to be allocated.

void removeVertex ( int num, int size ) #

Removes the specified number of elements starting from the specified one from the vertex buffer of the dynamic mesh.

Arguments

• int num - Number of the first vertex to be removed.
• int size - Number of vertices to be removed.

void setNumVertex ( int num ) #

Sets the total number of vertices for the dynamic mesh.

Arguments

• int num - New number of vertices.

int getNumVertex ( ) const#

Returns the total number of vertices for the dynamic mesh.

void addVertexArray ( const void * vertex, int num_vertex ) #

Adds a set of new elements to the vertex buffer of the dynamic mesh at once.

Arguments

• const void * vertex - Array of vertices to be added.
• int num_vertex - Number of vertices to add.

void setVertexArray ( const void * vertex, int num_vertex ) #

Replaces the current vertex buffer of the dynamic mesh with the specified array of vertices.

Arguments

• const void * vertex - Array of vertices to be added.
• int num_vertex - Number of vertices to add.

void addVertexHalf1 ( int attribute, float x ) #

Adds a new vertex with a single half coordinate to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.

void addVertexHalf2 ( int attribute, float x, float y ) #

Adds a new vertex with 2 half coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.

void addVertexHalf3 ( int attribute, float x, float y, float z ) #

Adds a new vertex with 3 half coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.

void addVertexHalf4 ( int attribute, float x, float y, float z, float w ) #

Adds a new vertex with 4 half coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.
• float w - W coordinate of the vertex.

void addVertexFloat ( int attribute, float[] value ) #

Adds a new vertex with float coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float[] value - Float-type coordinates of the vertex to be set.

void addVertexFloat1 ( int attribute, float x ) #

Adds a new vertex with a single float coordinate to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.

void addVertexFloat2 ( int attribute, float x, float y ) #

Adds a new vertex with 2 float coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.

void addVertexFloat3 ( int attribute, float x, float y, float z ) #

Adds a new vertex with 3 float coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.

void addVertexFloat4 ( int attribute, float x, float y, float z, float w ) #

Adds a new vertex with 4 float coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.
• float w - W coordinate of the vertex.

void addVertexUChar ( int attribute, uchar[] value ) #

Adds a new vertex with unsigned char coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• uchar[] value - Uchar-type coordinates of the vertex to be set.

void addVertexUChar1 ( int attribute, unsigned char x ) #

Adds a new vertex with a single unsigned char coordinate to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.

void addVertexUChar2 ( int attribute, unsigned char x, unsigned char y ) #

Adds a new vertex with 2 unsigned char coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.
• unsigned char y - Y coordinate of the vertex.

void addVertexUChar3 ( int attribute, unsigned char x, unsigned char y, unsigned char z ) #

Adds a new vertex with 3 unsigned char coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.
• unsigned char y - Y coordinate of the vertex.
• unsigned char z - Z coordinate of the vertex.

void addVertexUChar4 ( int attribute, unsigned char x, unsigned char y, unsigned char z, unsigned char w ) #

Adds a new vertex with 4 unsigned char coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.
• unsigned char y - Y coordinate of the vertex.
• unsigned char z - Z coordinate of the vertex.
• unsigned char w - W coordinate of the vertex.

void addVertexUShort ( int attribute, ushort[] value ) #

Adds a new vertex with unsigned short coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• ushort[] value - Ushort-type coordinates of the vertex to be set.

void addVertexUShort1 ( int attribute, unsigned short x ) #

Adds a new vertex with a single unsigned short coordinate to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.

void addVertexUShort2 ( int attribute, unsigned short x, unsigned short y ) #

Adds a new vertex with 2 unsigned short coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.
• unsigned short y - Y coordinate of the vertex.

void addVertexUShort3 ( int attribute, unsigned short x, unsigned short y, unsigned short z ) #

Adds a new vertex with 3 unsigned short coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.
• unsigned short y - Y coordinate of the vertex.
• unsigned short z - Z coordinate of the vertex.

void addVertexUShort4 ( int attribute, unsigned short x, unsigned short y, unsigned short z, unsigned short w ) #

Adds a new vertex with 4 unsigned short coordinates to the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.
• unsigned short y - Y coordinate of the vertex.
• unsigned short z - Z coordinate of the vertex.
• unsigned short w - W coordinate of the vertex.

void setVertexHalf1 ( int attribute, float x ) #

Sets half-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.

void setVertexHalf2 ( int attribute, float x, float y ) #

Sets half-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.

void setVertexHalf3 ( int attribute, float x, float y, float z ) #

Sets half-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.

void setVertexHalf4 ( int attribute, float x, float y, float z, float w ) #

Sets half-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.
• float w - W coordinate of the vertex.

void setVertexFloat ( int attribute, float[] value ) #

Sets float-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float[] value - Float-type coordinates to be set.

void setVertexFloat1 ( int attribute, float x ) #

Sets float-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.

void setVertexFloat2 ( int attribute, float x, float y ) #

Sets float-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.

void setVertexFloat3 ( int attribute, float x, float y, float z ) #

Sets float-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.

void setVertexFloat4 ( int attribute, float x, float y, float z, float w ) #

Sets float-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.
• float w - W coordinate of the vertex.

void setVertexUChar ( int attribute, uchar[] value ) #

Sets uchar-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• uchar[] value - Uchar-type coordinates to be set.

void setVertexUChar1 ( int attribute, unsigned char x ) #

Sets uchar-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.

void setVertexUChar2 ( int attribute, unsigned char x, unsigned char y ) #

Sets uchar-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.
• unsigned char y - Y coordinate of the vertex.

void setVertexUChar3 ( int attribute, unsigned char x, unsigned char y, unsigned char z ) #

Sets uchar-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.
• unsigned char y - Y coordinate of the vertex.
• unsigned char z - Z coordinate of the vertex.

void setVertexUChar4 ( int attribute, unsigned char x, unsigned char y, unsigned char z, unsigned char w ) #

Sets uchar-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.
• unsigned char y - Y coordinate of the vertex.
• unsigned char z - Z coordinate of the vertex.
• unsigned char w - W coordinate of the vertex.

void setVertexUShort ( int attribute, ushort[] value ) #

Sets ushort-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• ushort[] value - Ushort-type coordinates to be set.

void setVertexUShort1 ( int attribute, unsigned short x ) #

Sets ushort-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.

void setVertexUShort2 ( int attribute, unsigned short x, unsigned short y ) #

Sets ushort-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.
• unsigned short y - Y coordinate of the vertex.

void setVertexUShort3 ( int attribute, unsigned short x, unsigned short y, unsigned short z ) #

Sets ushort-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.
• unsigned short y - Y coordinate of the vertex.
• unsigned short z - Z coordinate of the vertex.

void setVertexUShort4 ( int attribute, unsigned short x, unsigned short y, unsigned short z, unsigned short w ) #

Sets ushort-type coordinates and specified attribute for the last vertex in the vertex buffer of the dynamic mesh.

Arguments

• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.
• unsigned short y - Y coordinate of the vertex.
• unsigned short z - Z coordinate of the vertex.
• unsigned short w - W coordinate of the vertex.

void setVertexHalf1 ( int vertex, int attribute, float x ) #

Sets half-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.

void setVertexHalf2 ( int vertex, int attribute, float x, float y ) #

Sets half-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.

void setVertexHalf3 ( int vertex, int attribute, float x, float y, float z ) #

Sets half-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.

void setVertexHalf4 ( int vertex, int attribute, float x, float y, float z, float w ) #

Sets half-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.
• float w - W coordinate of the vertex.

void setVertexFloat ( int vertex, int attribute, float[] value ) #

Sets float-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• float[] value - Float-type coordinates to be set.

void setVertexFloat1 ( int vertex, int attribute, float x ) #

Sets float-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.

void setVertexFloat2 ( int vertex, int attribute, float x, float y ) #

Sets float-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.

void setVertexFloat3 ( int vertex, int attribute, float x, float y, float z ) #

Sets float-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.

void setVertexFloat4 ( int vertex, int attribute, float x, float y, float z, float w ) #

Sets float-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• float x - X coordinate of the vertex.
• float y - Y coordinate of the vertex.
• float z - Z coordinate of the vertex.
• float w - W coordinate of the vertex.

void setVertexUChar ( int vertex, int attribute, uchar[] value ) #

Sets uchar-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• uchar[] value - Uchar-type coordinates to be set.

void setVertexUChar1 ( int vertex, int attribute, unsigned char x ) #

Sets uchar-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.

void setVertexUChar2 ( int vertex, int attribute, unsigned char x, unsigned char y ) #

Sets uchar-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.
• unsigned char y - Y coordinate of the vertex.

void setVertexUChar3 ( int vertex, int attribute, unsigned char x, unsigned char y, unsigned char z ) #

Sets uchar-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.
• unsigned char y - Y coordinate of the vertex.
• unsigned char z - Z coordinate of the vertex.

void setVertexUChar4 ( int vertex, int attribute, unsigned char x, unsigned char y, unsigned char z, unsigned char w ) #

Sets uchar-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• unsigned char x - X coordinate of the vertex.
• unsigned char y - Y coordinate of the vertex.
• unsigned char z - Z coordinate of the vertex.
• unsigned char w - W coordinate of the vertex.

void setVertexUShort ( int vertex, int attribute, ushort[] value ) #

Sets ushort-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• ushort[] value - Ushort-type coordinates to be set.

void setVertexUShort1 ( int vertex, int attribute, unsigned short x ) #

Sets ushort-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.

void setVertexUShort2 ( int vertex, int attribute, unsigned short x, unsigned short y ) #

Sets ushort-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.
• unsigned short y - Y coordinate of the vertex.

void setVertexUShort3 ( int vertex, int attribute, unsigned short x, unsigned short y, unsigned short z ) #

Sets ushort-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.
• unsigned short y - Y coordinate of the vertex.
• unsigned short z - Z coordinate of the vertex.

void setVertexUShort4 ( int vertex, int attribute, unsigned short x, unsigned short y, unsigned short z, unsigned short w ) #

Sets ushort-type coordinates and specified attribute for the specified vertex in the vertex buffer of the dynamic mesh.

Arguments

• int vertex - Vertex number.
• int attribute - Attribute to be set.
• unsigned short x - X coordinate of the vertex.
• unsigned short y - Y coordinate of the vertex.
• unsigned short z - Z coordinate of the vertex.
• unsigned short w - W coordinate of the vertex.

void clearIndices ( ) #

Removes all indices of the dynamic mesh.

void allocateIndices ( int num ) #

Allocates a given number of vertex indices in the index buffer. With this function, memory can be allocated once rather than in chunks, making the creation faster.

Arguments

• int num - Number of indices for which memory is to be allocated.

void removeIndices ( int num, int size ) #

Removes the specified number of indices starting from the specified one from the index buffer of the dynamic mesh.

Arguments

• int num - Number of the first index to be removed.
• int size - Number of indices to be removed.

void setNumIndices ( int num ) #

Sets the total number of indices for the dynamic mesh.

Arguments

• int num - New number of indices.

int getNumIndices ( ) const#

Returns the total number of indices for the dynamic mesh.

Return value

Number of indices.

void addIndex ( int index ) #

Adds a new index to the index buffer of the dynamic mesh.

Arguments

• int index - Index to be added.

void addIndexFast ( int index ) #

Adds a new index to the index buffer of the dynamic mesh.

Arguments

• int index - Index to be added.

void addIndices ( int i0, int i1 ) #

Adds two new indices to the index buffer of the dynamic mesh at once. This method can be used to add indices for a line strips via a single function call.

Arguments

• int i0 - First index to be added.
• int i1 - Second index to be added.

void addIndices ( int i0, int i1, int i2 ) #

Adds three new indices to the index buffer of the dynamic mesh at once. This method can be used to add indices for a triangle via a single function call.

Arguments

• int i0 - First index to be added.
• int i1 - Second index to be added.
• int i2 - Third index to be added.

void addIndices ( int i0, int i1, int i2, int i3 ) #

Adds four new indices to the index buffer of the dynamic mesh at once. This method can be used to add indices for a quad via a single function call.

Arguments

• int i0 - First index to be added.
• int i1 - Second index to be added.
• int i2 - Third index to be added.
• int i3 - Fourth index to be added.

void addIndicesArray ( const int* indices, int indices_size ) #

Adds a set of new elements to the index buffer of the dynamic mesh at once.

Arguments

• const int* indices - Array of indices to be added.
• int indices_size - Number of indices to be added.

void setIndicesArray ( const int* indices, int indices_size ) #

Replaces the current index buffer of the dynamic mesh with the specified array of indices.

Arguments

• const int* indices - Array of indices to be set.
• int indices_size - Number of indices to be set.

Vector< int > getIndicesArray ( ) #

Returns the index buffer of the dynamic mesh.

Return value

Vector containing the index buffer of the dynamic mesh.

void addPoints ( int num_points ) #

Adds the specified number of points to the dynamic mesh.

Arguments

• int num_points - Number of points to be added.

void addLineStrip ( int num_vertex ) #

Adds a line strip to the dynamic mesh. This method does not add vertices, rather it allocates indices, for which vertices should be then created with one of the addVertex*() methods. Indices will point to vertices starting from the current last vertex in the vertex buffer.

Arguments

• int num_vertex - Number of vertices comprising the strip.

void addTriangles ( int num_triangles ) #

Adds the specified number of triangles to the dynamic mesh.

Arguments

• int num_triangles - Number of triangles to be added.

void addTriangleFan ( int num_vertex ) #

Adds a triangle fan to the dynamic mesh. This method does not add vertices, rather it allocates indices, for which vertices should be then created with one of the addVertex*() methods. Indices will point to vertices starting from the current last vertex in the vertex buffer.

Arguments

• int num_vertex - Number of vertices comprising the fan.

void addTriangleStrip ( int num_vertex ) #

Adds a triangle strip to the dynamic mesh. This method does not add vertices, rather it allocates indices, for which vertices should be then created with one of the addVertex*() methods. Indices will point to vertices starting from the current last vertex in the vertex buffer.

Arguments

• int num_vertex - Number of vertices comprising the strip.

void addTriangleQuads ( int num_quads ) #

Adds a given number of quadrilaterals to the dynamic mesh. This method does not add vertices, rather it allocates indices, for which vertices should be then created with one of the addVertex*() methods. Indices will point to vertices starting from the current last vertex in the vertex buffer.

Arguments

• int num_quads - Number of quadrilaterals to be added.

bool saveState ( const Ptr<Stream> & stream ) const#

Saves the current state of the dynamic mesh (vertices, indices, etc.) to the specified stream.

Saving into the stream requires creating a blob to save into. To restore the saved state the restoreState() method is used:

Arguments

• const Ptr<Stream> & stream - Stream to which the state of the dynamic mesh is to be saved.

Return value

true if the current state of the dynamic mesh is saved successfully; otherwise, false.

bool restoreState ( const Ptr<Stream> & stream ) #

Restores a previously saved state of the dynamic mesh (vertices, indices, etc.) from the specified stream.

Restoring from the stream requires creating a blob to save into and saving the state using the saveState() method:

Arguments

• const Ptr<Stream> & stream - Stream from which the previously saved state of the dynamic mesh is to be loaded.

Return value

true if a previously saved state of the dynamic mesh is restored successfully; otherwise, false.

Ptr<ResourceExternalMemory> getExternalMemoryVertexBuffer ( ) const#

Returns the pointer to the vertex buffer of the resource in video memory. If the USAGE_MISC_SHARED flag is not enabled for the resource, this method returns nullptr.

Return value

The pointer to the vertex buffer of the resource in video memory. If the USAGE_MISC_SHARED flag is not enabled for the resource, this method returns nullptr.

Ptr<ResourceExternalMemory> getExternalMemoryIndexBuffer ( ) const#

Returns the pointer to the index buffer of the resource in video memory. If the USAGE_MISC_SHARED flag is not enabled for the resource, this method returns nullptr.

Return value

The pointer to the index buffer of the resource in video memory. If the USAGE_MISC_SHARED flag is not enabled for the resource, this method returns nullptr.