beastinstance.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 BEASTINSTANCE_H
#define BEASTINSTANCE_H

#include "beastapitypes.h"

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus

    typedef enum {
        ILB_RS_VISIBLE_FOR_EYE =            0x00000001,

        ILB_RS_VISIBLE_FOR_REFLECTIONS =    0x00000002,

        ILB_RS_VISIBLE_FOR_REFRACTIONS =    0x00000004,

        ILB_RS_VISIBLE_FOR_GI =             0x00000008,

        ILB_RS_CAST_SHADOWS =               0x00000010,

        ILB_RS_RECEIVE_SHADOWS =            0x00000020,

        ILB_RS_CAST_GI =                    0x00000040,

        ILB_RS_RECEIVE_GI =                 0x00000080,

        ILB_RS_CAST_OCCLUSION =             0x00000100,

        ILB_RS_RECEIVE_OCCLUSION =          0x00000200,

        ILB_RS_DOUBLE_SIDED =               0x00000400,

        ILB_RS_OPPOSITE =                   0x00000800,

        ILB_RS_SELF_OCCLUSION =             0x00001000,

        ILB_RS_SHADOW_BIAS =                0x00002000,

        ILB_RS_RESERVED_1 =                 0x00004000,

        ILB_RS_PRIMARY_VISIBILITY = ILB_RS_VISIBLE_FOR_EYE,

        ILB_RS_VISIBLE_IN_REFLECTIONS = ILB_RS_VISIBLE_FOR_REFLECTIONS,

        ILB_RS_VISIBLE_IN_REFRACTIONS = ILB_RS_VISIBLE_FOR_REFRACTIONS,

        ILB_RS_VISIBLE_IN_FINAL_GATHER = ILB_RS_VISIBLE_FOR_GI,

    } ILBRenderStats;
    
    typedef enum {
        ILB_RSOP_DISABLE,
        ILB_RSOP_ENABLE,
    } ILBRenderStatOperation;

    typedef uint32 ILBRenderStatsMask;

    ILB_DLL_FUNCTION ILBStatus ILBCreateInstance(ILBSceneHandle scene, 
        ILBMeshHandle mesh,
        ILBConstString name, 
        const ILBMatrix4x4* transform,
        ILBInstanceHandle* instance);

    ILB_DLL_FUNCTION ILBStatus ILBSetInstanceTransform(ILBInstanceHandle instance,
                                                    const ILBMatrix4x4* transform);

    ILB_DLL_FUNCTION ILBStatus ILBSetInstanceMotionTransforms(ILBInstanceHandle instance,
                                                        const ILBMatrix4x4* transforms,
                                                        int32 count);

    ILB_DLL_FUNCTION ILBStatus ILBSetRenderStats(ILBInstanceHandle instance, 
                                       ILBRenderStatsMask stats,
                                       ILBRenderStatOperation operation);

    ILB_DLL_FUNCTION ILBStatus ILBSetInstanceMesh(ILBInstanceHandle instance,
                                        ILBMeshHandle mesh);

    ILB_DLL_FUNCTION ILBStatus ILBAddInstanceLightLinks(ILBInstanceHandle instance, 
                                                ILBLightLinkMode mode,
                                                const ILBLightHandle* lightSources, 
                                                int32 count);
    
    ILB_DLL_FUNCTION ILBStatus ILBSetMaterialOverrides(ILBInstanceHandle instance, 
                                               ILBMaterialHandle* materials,
                                               int32 materialCount);
    ILB_DLL_FUNCTION ILBStatus ILBAddLODInstance(ILBInstanceHandle lowRes, 
        ILBInstanceHandle highRes);

    ILB_DLL_FUNCTION ILBStatus ILBSetInstanceDisplayName(ILBInstanceHandle instance, 
                                                 ILBConstString displayName);

    ILB_DLL_FUNCTION ILBStatus ILBDeleteInstance(ILBInstanceHandle instance);

#ifdef __cplusplus
}
#endif // __cplusplus


#endif / / BEASTINSTANCE_H