libOMA Documentation

Main

Contacts

Documents

FAQ

License

Project

omaut.h File Reference

Header for the utility libOMAUT library. More...

Go to the source code of this file.

Functions
OMAUTAPI void OMAUTAPIENTRY	omautGLMapVertexArray (void)
	Maps the current chunk and sets OpenGL's vertex pointer to it.
OMAUTAPI void OMAUTAPIENTRY	omautGLMapTexCoordArray (void)
	Maps the current chunk and sets OpenGL's texture coordinate pointer to it.
OMAUTAPI void OMAUTAPIENTRY	omautGLMapNormalArray (void)
	Maps the current chunk and sets OpenGL's normal pointer to it.
OMAUTAPI void OMAUTAPIENTRY	omautGLMapColorArray (void)
	Maps the current chunk and sets OpenGL's color pointer to it.
OMAUTAPI void OMAUTAPIENTRY	omautGLMapFrame (OMAuint index, OMAvoid *type, OMAsizei *count, const OMAuint **indices)
	Maps the current chunk's referenced chunks using the other omautGLMap functions.
OMAUTAPI void OMAUTAPIENTRY	omautGLMapObject (OMAvoid *type, OMAsizei *count, const OMAuint **indices)
	Maps the current chunk's referenced chunks using the other omautGLMap functions.
OMAUTAPI void OMAUTAPIENTRY	omautGLDrawObject (void)
	Maps the current chunk's referenced chunks using the other omautGLMap functions and draws all of the data mapped.
OMAUTAPI void OMAUTAPIENTRY	omautGLDrawKeyframe (OMAfloat index)
	Interpolates and draws the current chunk's referenced chunks with the specified index using the other omautGLMap functions.

---

Detailed Description

---

Function Documentation

OMAUTAPI void OMAUTAPIENTRY omautGLDrawKeyframe (  OMAfloat  index  )

omautGLDrawKeyframe interpolates and draws the current chunk's referenced chunks with the specified index using the other omautGLMap functions. Any reference chunks that need to be accessed may be mapped. If the chunks are already mapped, they will not be remapped and must have been mapped with at least read permission. Unmapping the chunks is up to the caller. Note: Only present if OpenGL was available during libOMAUT's build process.

OMAUTAPI void OMAUTAPIENTRY omautGLDrawObject (  void   )

omautGLDrawObject maps the current chunk's referenced chunk using the other omautGLMap functions and draws of the data mapped with OpenGL. Since this function calls omautGLMapObject, some chunks will be left mapped after calling it. The currently bound chunk's type must be OMA_OBJECT. See also: omautGLMapObject Note: Only present if OpenGL was available during libOMAUT's build process.

OMAUTAPI void OMAUTAPIENTRY omautGLMapColorArray (  void   )

omautGLMapColorArray maps the current chunk's referenced chunks using the other omautGLMap functions. If the chunk is already mapped, it will not be remapped and must have been mapped with at least read permission. If the chunk is not mapped, it will be mapped read-only. Unmapping the chunk is up to the caller. The currently bound chunk's type must be one of: OMA_FLOAT3 OMA_FLOAT4 Note: Only present if OpenGL was available during libOMAUT's build process.

OMAUTAPI void OMAUTAPIENTRY omautGLMapFrame (  OMAuint  index, OMAvoid *  type, OMAsizei *  count, const OMAuint **  indices )

omautGLMapFrame maps the current chunk's referenced chunks using the other omautGLMap functions. If the chunk is already mapped, it will not be remapped and must have been mapped with at least read permission. If the chunk is not mapped, it will be unmapped before omautGLMapFrame returns. The currently bound chunk's type must be OMA_FRAME. Parameters: index  The index of the frame chunk to use. type  A pointer to a GLenum to store the geometry type in. count  A pointer to an OMAsizei to store the vertex count in. indices  A pointer to an OMAuint pointer to store the address of the indices in. The pointer is set to NULL if there are no indices. See also: omautGLMapVertexArray omautGLMapTexCoordArray omautGLMapNormalArray omautGLMapColorArray Note: Only present if OpenGL was available during libOMAUT's build process.

OMAUTAPI void OMAUTAPIENTRY omautGLMapNormalArray (  void   )

omautGLMapNormalArray maps the current chunk's referenced chunks using the other omautGLMap functions. If the chunk is already mapped, it will not be remapped and must have been mapped with at least read permission. If the chunk is not mapped, it will be mapped read-only. Unmapping the chunk is up to the caller. The currently bound chunk's type must be one of: OMA_FLOAT3 Note: Only present if OpenGL was available during libOMAUT's build process.

OMAUTAPI void OMAUTAPIENTRY omautGLMapObject (  OMAvoid *  type, OMAsizei *  count, const OMAuint **  indices )

omautGLMapObject maps the current chunk's referenced chunks using the other omautGLMap functions. If the chunk is already mapped, it will not be remapped and must have been mapped with at least read permission. If the chunk is not mapped, it will be unmapped before omautGLMapObject returns. The currently bound chunk's type must be OMA_OBJECT. Parameters: type  A pointer to a GLenum to store the geometry type in. count  A pointer to an OMAsizei to store the vertex count in. indices  A pointer to an OMAuint pointer to store the address of the indices in. The pointer is set to NULL if there are no indices. See also: omautGLMapFrame Note: Only present if OpenGL was available during libOMAUT's build process.

OMAUTAPI void OMAUTAPIENTRY omautGLMapTexCoordArray (  void   )

omautGLMapTexCoordArray maps the current chunk's referenced chunks using the other omautGLMap functions. If the chunk is already mapped, it will not be remapped and must have been mapped with at least read permission. If the chunk is not mapped, it will be mapped read-only. Unmapping the chunk is up to the caller. The currently bound chunk's type must be one of: OMA_FLOAT OMA_FLOAT2 OMA_FLOAT3 OMA_FLOAT4 OMA_SET [1] 1: Only allowed if the OpenGL MCD's version is greater than or equal to 1.3, allowing the use of the former-extension GL_ARB_multitexture. If the set chunk is already mapped it will not be remapped and must have been mapped with read permission. If the set chunk is not mapped, it will be unmapped before omautGLMapTexCoordArray returns. The chunks referenced by the set chunk will all be treated by the previously specified rules. Note: Only present if OpenGL was available during libOMAUT's build process.

OMAUTAPI void OMAUTAPIENTRY omautGLMapVertexArray (  void   )

omautGLMapVertexArray maps the current chunk's referenced chunks using the other omautGLMap functions. If the chunk is already mapped, it will not be remapped and must have been mapped with at least read permission. If the chunk is not mapped, it will be mapped read-only. Unmapping the chunk is up to the caller. The currently bound chunk's type must be one of: OMA_FLOAT2 OMA_FLOAT3 OMA_FLOAT4 Note: Only present if OpenGL was available during libOMAUT's build process.