beastapitypes.h

Go to the documentation of this file.

/*
Copyright 2014 Autodesk, Inc.  All rights reserved.
Use of this software is subject to the terms of the Autodesk license agreement
provided at the time of installation or download, or which otherwise 
accompanies this software in either electronic or hard copy form.
*/


#ifndef BEASTAPITYPES_H
#define BEASTAPITYPES_H

#ifdef __GNUC__
#include <stdint.h>
#endif // __GNUC__

// To enforce a certain string encoding use any of
//#define ILB_STRING_UTF8
//#define ILB_STRING_UTF16
//#define ILB_STRING_UTF32
//#define ILB_STRING_ANSI

typedef enum {
    ILB_SE_ANSI,
    ILB_SE_UTF8,
    
    ILB_SE_UTF16,

    ILB_SE_UTF32,
} ILBStringEncoding;

// Try to auto detect a string encoding if no was supplied
#if !(defined(ILB_STRING_UTF8) || defined(ILB_STRING_UTF16) || defined(ILB_STRING_UTF32) || defined(ILB_STRING_ANSI))
#if defined(WIN32)
#ifdef UNICODE
#define ILB_STRING_UTF16
#else // UNICODE
#define ILB_STRING_ANSI
#endif // UNICODE
#else // WIN32
#define ILB_STRING_UTF8
#endif // WIN32
#endif // !(defined(ILB_STRING_UTF8) || defined(ILB_STRING_UTF16) || defined(ILB_STRING_UTF32) || defined(ILB_STRING_ANSI))

typedef char ILBChar8;

#if defined(WIN32)

typedef wchar_t ILBChar16;
#else // defined(WIN32)

typedef unsigned short ILBChar16;
#endif // defined(WIN32)

typedef unsigned int ILBChar32;

#ifdef beastapi_EXPORTS
// This is for inside the API. By setting char type
// to ILBDummyChar we guarantee that someone accidentially
// converts strings or string constants to ILBString 
// or ILBConstString without thinking about encoding
struct ILBDummyChar {
    int unused;
};

typedef ILBDummyChar ILBCharType;
#define ILB_STRING_ENCODING ILB_SE_ANSI
#else // beastapi_EXPORTS

#if defined(ILB_STRING_ANSI)
typedef ILBChar8 ILBCharType;
#if defined(WIN32)
#define ILB_STRING_ENCODING ILB_SE_ANSI
#else // WIN32
#error ANSI strings only supported on Windows platforms
#endif // WIN32
#elif defined(ILB_STRING_UTF8)
typedef ILBChar8 ILBCharType;
#define ILB_STRING_ENCODING ILB_SE_UTF8
#elif defined(ILB_STRING_UTF16)
typedef ILBChar16 ILBCharType;
#define ILB_STRING_ENCODING ILB_SE_UTF16
#elif defined(ILB_STRING_UTF32)
#error UTF32 currently not supported
typedef ILBChar32 ILBCharType;
#define ILB_STRING_ENCODING ILB_SE_UTF32
#else
#error No string type defined
#endif //ILB_STRING_UTF8

#endif //beastapi_EXPORTS


typedef enum {
    ILB_ST_SUCCESS = 0,
    
    ILB_ST_INVALID_PARAMETER, 

    ILB_ST_MEMORY_ALLOC_ERROR,

    ILB_ST_DUPLICATE_NAME_ERROR,

    ILB_ST_FUNCTION_NOT_IMPLEMENTED,

    ILB_ST_INVALID_OBJECT_STATE,
    
    ILB_ST_INVALID_HANDLE,
    
    ILB_ST_FILE_IO_ERROR,

    ILB_ST_UNKNOWN_OBJECT,

    ILB_ST_NOT_SUPPORTED,

    ILB_ST_UNHANDLED_EXCEPTION,

    ILB_ST_JOB_EXECUTION_FAILURE,

    ILB_ST_ATLAS_EXECUTION_FAILURE,

    ILB_ST_INVALID_LICENSE,

    ILB_ST_LAST_ERROR,
} ILBStatus;

typedef ILBCharType* ILBString;

typedef const ILBCharType* ILBConstString;


#ifdef WIN32

typedef __int32 int32;

typedef __int64 int64;

typedef unsigned __int32 uint32;

typedef unsigned __int64 uint64;

#elif defined(__GNUC__)

typedef int32_t int32;
typedef int64_t int64;
typedef uint32_t uint32;
typedef uint64_t uint64;
typedef uint32 DWORD;
#else
#error Could not define int32 and friends.
#endif

typedef int32 ILBBool;

typedef struct ILBVec2 {
    float x;
    float y;
#ifdef __cplusplus
    ILBVec2() {}
    ILBVec2(float _x, float _y): x(_x), y(_y) {}
#endif // __cplusplus
} ILBVec2;

typedef struct ILBVec2i {
    int x;
    int y;
#ifdef __cplusplus
    ILBVec2i() {}
    ILBVec2i(int _x, int _y): x(_x), y(_y) {}
#endif // __cplusplus
} ILBVec2i;

typedef struct ILBVec3 {
    float x;
    float y;
    float z;
#ifdef __cplusplus
    ILBVec3() {}
    ILBVec3(float _x, float _y, float _z): x(_x), y(_y), z(_z) {}
#endif // __cplusplus
} ILBVec3;

typedef struct ILBLinearRGB {
    float r;
    float g;
    float b;
#ifdef __cplusplus
    ILBLinearRGB() {}
    ILBLinearRGB(float _r, float _g, float _b): r(_r), g(_g), b(_b) {}
#endif // __cplusplus
} ILBLinearRGB;

typedef struct ILBLinearRGBA {
    float r;
    float g;
    float b;
    float a;
#ifdef __cplusplus
    ILBLinearRGBA() {}
    ILBLinearRGBA(float _r, float _g, float _b, float _a): r(_r), g(_g), b(_b), a(_a) {}
#endif // __cplusplus
} ILBLinearRGBA;

typedef struct {
    float m[16];
} ILBMatrix4x4;

/*
 * Macro to define handle types.
 * Inspired by windows headers
 */
#define ILB_DECLARE_HANDLE(name) struct name##__{int unused;}; typedef struct name##__ *name;

ILB_DECLARE_HANDLE(ILBManagerHandle)


ILB_DECLARE_HANDLE(ILBMeshHandle);

ILB_DECLARE_HANDLE(ILBSceneHandle);

ILB_DECLARE_HANDLE(ILBSceneInfoHandle);

ILB_DECLARE_HANDLE(ILBInstanceHandle);

ILB_DECLARE_HANDLE(ILBCameraHandle);

ILB_DECLARE_HANDLE(ILBLightHandle);

ILB_DECLARE_HANDLE(ILBMaterialHandle);

ILB_DECLARE_HANDLE(ILBTextureHandle);

ILB_DECLARE_HANDLE(ILBJobHandle);

ILB_DECLARE_HANDLE(ILBJobUpdateHandle);

ILB_DECLARE_HANDLE(ILBStringHandle);

ILB_DECLARE_HANDLE(ILBTargetHandle);


ILB_DECLARE_HANDLE(ILBFramebufferHandle);


ILB_DECLARE_HANDLE(ILBTargetEntityHandle);

ILB_DECLARE_HANDLE(ILBRenderPassHandle);

ILB_DECLARE_HANDLE(ILBLightPassEntryHandle);

ILB_DECLARE_HANDLE(ILBPointCloudHandle);

ILB_DECLARE_HANDLE(ILBShaderHandle);

ILB_DECLARE_HANDLE(ILBUVLayerHandle);

typedef enum {
    ILB_LL_EXCLUDING = 0,
    
    ILB_LL_INCLUDING,
} ILBLightLinkMode;

/*
 * Setup for getting functions exported or imported from the DLL
 * on windows
 */
#ifdef WIN32
#ifdef beastapi_EXPORTS
#define ILB_DLL_FUNCTION __declspec(dllexport)
#else
#define ILB_DLL_FUNCTION __declspec(dllimport)
#endif // beastapi_EXPORTS
#else // WIN32
#define ILB_DLL_FUNCTION 
#endif // WIN32

#ifdef WIN32
typedef void* ILBFileHandle;
#define ILB_INVALID_FILE_HANDLE ((void*)(((unsigned char*)(0)) - 1))
#else // WIN32
typedef int32 ILBFileHandle;
#define ILB_INVALID_FILE_HANDLE -1
#endif // WIN32

#endif //BEASTAPITYPES_H