libOMA Documentation

Main

Contacts

Documents

FAQ

License

Project

oma.h

Go to the documentation of this file.

/* Copyright 2003, OMA Group
        This file is licenced under a BSD derived license with exact
        terms specified in the COPYING file supplied. If this file
        was not supplied, you may find more information at:
                http://omapi.sourceforge.net
*/
                                                                                
#ifndef INCLUDE_OMAPI__OMA_OMA_H
#define INCLUDE_OMAPI__OMA_OMA_H

#include <stddef.h>
#include <stdint.h>

typedef unsigned int   OMAenum;
typedef unsigned char  OMAboolean;
typedef unsigned int   OMAbitfield;
typedef void           OMAvoid;
typedef signed char    OMAbyte;
typedef short          OMAshort;
typedef int            OMAint;
typedef unsigned char  OMAubyte;
typedef unsigned short OMAushort;
typedef unsigned int   OMAuint;
typedef int            OMAsizei;
typedef float          OMAfloat;
typedef float          OMAclampf;
typedef double         OMAdouble;
typedef double         OMAclampd;
typedef intptr_t       OMAintptr;
typedef size_t         OMAsizeiptr;

/* General Enums */
enum {
        OMA_UNKNOWN = 0
};

/* Boolean Enums */
enum {
        OMA_FALSE = 0,
        OMA_TRUE  = 1
};

/* Chunk Type Enums */
enum {
        OMA_TEXT      =      1,
        OMA_INT       =    200,
        OMA_FLOAT     =    300,
        OMA_FLOAT2    =    301,
        OMA_FLOAT3    =    302,
        OMA_FLOAT4    =    303,
        OMA_SET       =    800,
        OMA_QUAT      =    900,
        OMA_MATRIX    =    901,
        OMA_FRAME     =   2000,
        OMA_OBJECT    =   3000,
        OMA_KEYFRAME  =   3001,
        OMA_EXTENSION = 100000
};

/* Geometry Type Enums */
enum {
        OMA_TRIANGLES      =  1,
        OMA_TRIANGLE_STRIP =  2,
        OMA_TRIANGLE_FAN   =  3,
        OMA_QUADS          =  4,
        OMA_QUAD_STRIP     =  5,
        OMA_LINES          =  6,
        OMA_LINE_LOOP      =  7,
        OMA_LINE_STRIP     =  8,
        OMA_POLYGON        =  9,
        OMA_POINTS         = 10
};

/* Transistion Type Enums */
enum {
        OMA_ROUND_DOWN           = 1,
        OMA_ROUND_UP             = 2,
        OMA_ROUND_NEAREST        = 3,
        OMA_LINEAR_INTERPOLATION = 4,
        OMA_CUBIC_INTERPOLATION  = 5
};

/* Error Enums */
enum {
        OMA_NO_ERROR           = 0,
        OMA_INVALID_ENUM       = 1,
        OMA_INVALID_VALUE      = 2,
        OMA_INVALID_OPERATION  = 3,
        OMA_OUT_OF_MEMORY      = 4,
        OMA_INTERNAL_ERROR     = 5,
        OMA_FILE_IO_ERROR      = 6,
        OMA_STACK_OVERFLOW     = 7,
        OMA_STACK_UNDERFLOW    = 8
};

/* String Enums (1000000 - 1000999) */
enum {
        OMA_VENDOR     = 1000000,
        OMA_VERSION    = 1000001,
        OMA_EXTENSIONS = 1000002,
};

/* Int Enums (1001000 - 1001999) */
enum {
        /* Get */
        OMA_CHUNK_BINDING         = 1001000,
        OMA_CHUNK_STACK_DEPTH     = 1001001,
        OMA_MAX_CHUNK_STACK_DEPTH = 1001002,

        /* GetChunkParameter */
        OMA_CHUNK_TYPE            = 1001500,
        OMA_CHUNK_SIZE            = 1001501,
        OMA_CHUNK_ELEM_COUNT      = 1001502,
        OMA_CHUNK_ELEM_SIZE       = 1001503,
        OMA_CHUNK_ACCESS          = 1001550,
        OMA_CHUNK_MAPPED          = 1001551
};

/* Pointer Enums (1002000 - 1002999) */
enum {
        /* GetChunkPointer */
        OMA_CHUNK_MAP_POINTER     = 1002500
};

/* Chunk Stride Int Enums (> 5000000) */
enum {
        OMA_TEXT_STRIDE      = 5000000 + OMA_TEXT,
        OMA_INT_STRIDE       = 5000000 + OMA_INT,
        OMA_FLOAT_STRIDE     = 5000000 + OMA_FLOAT,
        OMA_FLOAT2_STRIDE    = 5000000 + OMA_FLOAT2,
        OMA_FLOAT3_STRIDE    = 5000000 + OMA_FLOAT3,
        OMA_FLOAT4_STRIDE    = 5000000 + OMA_FLOAT4,
        OMA_SET_STRIDE       = 5000000 + OMA_SET,
        OMA_QUAT_STRIDE      = 5000000 + OMA_QUAT,
        OMA_MATRIX_STRIDE    = 5000000 + OMA_MATRIX,
        OMA_FRAME_STRIDE     = 5000000 + OMA_FRAME,
        OMA_OBJECT_STRIDE    = 5000000 + OMA_OBJECT,
        OMA_KEYFRAME_STRIDE  = 5000000 + OMA_FRAME,
        OMA_EXTENSION_STRIDE = 5000000 + OMA_EXTENSION
};

/* Format Type Enums */
enum {
        OMA_OMA           = 1,
        OMA_OMX           = 2,
        OMA_WFOBJ         = 3,
        OMA_3DS           = 4,
        OMA_MD2           = 5,
        OMA_MD3           = 6
};

/* Access Type Enums */
enum {
        OMA_READ_ONLY  = 1,
        OMA_WRITE_ONLY = 2,
        OMA_READ_WRITE = 3
};

/* Attrib Bitfield Enums */
enum {
        OMA_CHUNK_BIT       = 0x00000001,
        OMA_ALL_ATTRIB_BITS = 0xFFFFFFFF
};

#define OMAAPI      extern
#define OMAAPIENTRY

OMAAPI OMAenum         OMAAPIENTRY omaGetError(void);

OMAAPI const OMAubyte* OMAAPIENTRY omaGetString(OMAenum pname);

OMAAPI void*           OMAAPIENTRY omaGetProcAddress(const OMAubyte *which);

OMAAPI OMAboolean      OMAAPIENTRY omaGetBoolean(OMAenum pname);

OMAAPI void            OMAAPIENTRY omaGetBooleanv(OMAenum pname, OMAboolean *params);

OMAAPI OMAint          OMAAPIENTRY omaGetInteger(OMAenum pname);

OMAAPI void            OMAAPIENTRY omaGetIntegerv(OMAenum pname, OMAint *params);

OMAAPI void            OMAAPIENTRY omaGetFloatv(OMAenum pname, OMAfloat *params);

OMAAPI void            OMAAPIENTRY omaGetDoublev(OMAenum pname, OMAdouble *params);

OMAAPI void            OMAAPIENTRY omaInit(void);

OMAAPI void            OMAAPIENTRY omaShutdown(void);

OMAAPI void            OMAAPIENTRY omaPushAttrib(OMAbitfield mask);

OMAAPI void            OMAAPIENTRY omaPopAttrib(void);

OMAAPI void            OMAAPIENTRY omaBindChunk(OMAuint name);

OMAAPI void            OMAAPIENTRY omaDeleteChunks(OMAsizei n, const OMAuint *chunks);

OMAAPI void            OMAAPIENTRY omaGenChunks(OMAsizei n, OMAuint *chunks);

OMAAPI OMAboolean      OMAAPIENTRY omaIsChunk(OMAuint name);

OMAAPI OMAint          OMAAPIENTRY omaGetChunkParameteri(OMAenum pname);

OMAAPI void            OMAAPIENTRY omaGetChunkParameteriv(OMAenum pname, OMAint *params);

OMAAPI void*           OMAAPIENTRY omaGetChunkPointer(OMAenum pname);

OMAAPI void            OMAAPIENTRY omaGetChunkPointerv(OMAenum pname, void **params);

OMAAPI void            OMAAPIENTRY omaChunkData(OMAenum type, OMAsizeiptr size, const OMAvoid *data);

OMAAPI void            OMAAPIENTRY omaChunkSubData(OMAintptr offset, OMAsizeiptr size, const OMAvoid *data);

OMAAPI void            OMAAPIENTRY omaGetChunkSubData(OMAintptr offset, OMAsizeiptr size, OMAvoid *data);

OMAAPI void*           OMAAPIENTRY omaMapChunk(OMAenum access);

OMAAPI void            OMAAPIENTRY omaUnmapChunk(void);

OMAAPI void            OMAAPIENTRY omaLoadPath(OMAenum format, const OMAubyte *path);

OMAAPI void            OMAAPIENTRY omaLoadBuffer(OMAenum format, const OMAubyte *buffer, OMAsizeiptr size);

#endif