beastuvlayer.h File Reference

#include "beastapitypes.h"

File Description

The Beast uv layer functions.

Functions
ILBStatus	ILBDestroyUVLayer (ILBUVLayerHandle uvLayer)
ILBStatus	ILBGetUVLayerIndexSize (ILBUVLayerHandle uvLayer, int32 *size)
ILBStatus	ILBGetUVLayerSize (ILBUVLayerHandle uvLayer, int32 *size)
ILBStatus	ILBReadUVLayerIndexValues (ILBUVLayerHandle uvLayer, int32 start, int32 count, int32 *uvIndex)
ILBStatus	ILBReadUVLayerValues (ILBUVLayerHandle uvLayer, int32 start, int32 count, ILBVec2 *uvs)

Function Documentation

ILBStatus ILBDestroyUVLayer

(

ILBUVLayerHandle

uvLayer

)

Destroys and frees all memory related to the uv layer.

The uv layer handle will be invalid afterwards.

Parameters

uvLayer

the uv layer to erase

Returns

The result of the operation.

ILBStatus ILBGetUVLayerIndexSize	(	ILBUVLayerHandle	uvLayer,
		int32 *	size
	)

Gets the number of uv index values in the layer.

There is one index value for each face vertex of the mesh the layer was created for.

Parameters

uvLayer	the uv layer to get the index size of
size	pointer to where the size shall be written

Returns

The result of the operation.

Examples:

ILBStatus ILBGetUVLayerSize	(	ILBUVLayerHandle	uvLayer,
		int32 *	size
	)

Gets the number of uv values in the layer.

Parameters

uvLayer	the uv layer to get the size of
size	pointer to where the size shall be written

Returns

The result of the operation.

Examples:

ILBStatus ILBReadUVLayerIndexValues	(	ILBUVLayerHandle	uvLayer,
		int32	start,
		int32	count,
		int32 *	uvIndex
	)

Reads uv index values from the uv layer The index values are use to assign uvs to the mesh the uv layer was created for.

There is one index value for each face vertex of the mesh the layer was created for. For each face vertex in the mesh the uv index points into the uv array, specifying which uv to assign to that face vertex.

Parameters

uvLayer	the uv layer to read values from
start	the index to the first element to read
count	the number of elements to read
uvIndex	pointer to an array where the values shall be written, must be large enough to hold all values

Returns

The result of the operation.

Examples:

ILBStatus ILBReadUVLayerValues	(	ILBUVLayerHandle	uvLayer,
		int32	start,
		int32	count,
		ILBVec2 *	uvs
	)

Reads a number of uv values from the uv layer.

Parameters

uvLayer	the uv layer to read values from
start	the index to the first element to read
count	the number of elements to read
uvs	pointer to an array where the values shall be written, must be large enough to hold all values

Returns

The result of the operation.

Examples:

Go to the source code of this file.