beastlightsource.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 BEASTLIGHTSOURCE_H
#define BEASTLIGHTSOURCE_H

#include "beastapitypes.h"

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

typedef enum {
    ILB_LST_DIRECTIONAL = 0,

    ILB_LST_POINT,

    ILB_LST_AREA,

    ILB_LST_SPOT,

    ILB_LST_WINDOW,

    ILB_LST_SKY,

    ILB_LST_AMBIENT,

} ILBLightType;

typedef enum {
    ILB_FO_EXPONENT = 0,
    ILB_FO_MAX_RANGE,

    ILB_FO_POLYNOMIAL

} ILBFalloffType;

typedef enum {
    ILB_LVT_INFINITY = 0,

    ILB_LVT_SPHERE,

    ILB_LVT_CUBE
} ILBLightVolumeType;

typedef enum {
    ILB_LS_VISIBLE_FOR_EYE          = 0x00000001,

    ILB_LS_VISIBLE_FOR_REFLECTIONS  = 0x00000002,

    ILB_LS_VISIBLE_FOR_REFRACTIONS  = 0x00000004,

    ILB_LS_VISIBLE_FOR_GI           = 0x00000008,

} ILBLightStats;

typedef enum {
    ILB_LSOP_DISABLE,
    ILB_LSOP_ENABLE,
    ILB_LSOP_SET,
} ILBLightStatOperation;

typedef uint32 ILBLightStatsMask;

ILB_DLL_FUNCTION ILBStatus ILBCreatePointLight(ILBSceneHandle scene, 
                                       ILBConstString name, 
                                       const ILBMatrix4x4* transform,
                                       const ILBLinearRGB* intensity,
                                       ILBLightHandle* light);

ILB_DLL_FUNCTION ILBStatus ILBCreateSpotLight(ILBSceneHandle scene, 
                                      ILBConstString name, 
                                      const ILBMatrix4x4* transform,
                                      const ILBLinearRGB* intensity,
                                      ILBLightHandle* light);

ILB_DLL_FUNCTION ILBStatus ILBCreateDirectionalLight(ILBSceneHandle scene, 
                                             ILBConstString name, 
                                             const ILBMatrix4x4* transform,
                                             const ILBLinearRGB* intensity,
                                             ILBLightHandle* light);

ILB_DLL_FUNCTION ILBStatus ILBCreateAreaLight(ILBSceneHandle scene, 
                                      ILBConstString name, 
                                      const ILBMatrix4x4* transform,
                                      const ILBLinearRGB* intensity,
                                      ILBLightHandle* light);

ILB_DLL_FUNCTION ILBStatus ILBCreateWindowLight(ILBSceneHandle scene, 
                                        ILBConstString name, 
                                        const ILBMatrix4x4* transform,
                                        const ILBLinearRGB* intensity,
                                        ILBLightHandle* light);

ILB_DLL_FUNCTION ILBStatus ILBCreateSkyLight(ILBSceneHandle scene, 
                                        ILBConstString name, 
                                        const ILBMatrix4x4* transform,
                                        const ILBLinearRGB* intensity,
                                        ILBLightHandle* light);

ILB_DLL_FUNCTION ILBStatus ILBCreateAmbientLight(ILBSceneHandle scene, 
                                        ILBConstString name, 
                                        const ILBMatrix4x4* transform,
                                        const ILBLinearRGB* intensity,
                                        ILBLightHandle* light);

ILB_DLL_FUNCTION ILBStatus ILBSetLightTransform(ILBLightHandle light,
                                                const ILBMatrix4x4* transform);


ILB_DLL_FUNCTION ILBStatus ILBSetLightColor(ILBLightHandle light,
                                            const ILBLinearRGB* color);

ILB_DLL_FUNCTION ILBStatus ILBSetLightIntensity(ILBLightHandle light, float intensity);

ILB_DLL_FUNCTION ILBStatus ILBSetCastShadows(ILBLightHandle light, ILBBool castShadows);

ILB_DLL_FUNCTION ILBStatus ILBSetShadowRadius(ILBLightHandle light, float radius);

ILB_DLL_FUNCTION ILBStatus ILBSetShadowAngle(ILBLightHandle light, float angleRadians);

ILB_DLL_FUNCTION ILBStatus ILBSetShadowSamples(ILBLightHandle light, int32 samples);

ILB_DLL_FUNCTION ILBStatus ILBAddLightLightLinks(ILBLightHandle light, 
                                         ILBLightLinkMode mode,
                                         const ILBInstanceHandle* instances, 
                                         int32 count);

ILB_DLL_FUNCTION ILBStatus ILBSetFalloff(ILBLightHandle light, 
                                         ILBFalloffType type, 
                                         float exponent, 
                                         float cutoff,
                                         ILBBool clampToOne);

ILB_DLL_FUNCTION ILBStatus ILBSetLightMaxRangeFalloff(ILBLightHandle light, 
                                                 float cutoff, 
                                                 float exponent);

ILB_DLL_FUNCTION ILBStatus ILBSetLightExponentFalloff(ILBLightHandle light, 
                                                 float cutoff, 
                                                 float exponent, 
                                                 ILBBool clampToOne);

ILB_DLL_FUNCTION ILBStatus ILBSetLightPolynomialFalloff(ILBLightHandle light, 
                                                   float cutoff, 
                                                   float constant, 
                                                   float linear, 
                                                   float quadratic, 
                                                   ILBBool clampToOne);

ILB_DLL_FUNCTION ILBStatus ILBSetSpotlightCone(ILBLightHandle light, 
                                       float angleRadians,
                                       float penumbraAngleRadians,
                                       float penumbraExponent);

ILB_DLL_FUNCTION ILBStatus ILBSetClippingPlanes(ILBLightHandle light, float nearDistance, float farDistance);

ILB_DLL_FUNCTION ILBStatus ILBSetIntensityScale(ILBLightHandle light, 
                                       float directScale,
                                       float indirectScale);

ILB_DLL_FUNCTION ILBStatus ILBSetLightStats(ILBLightHandle light, 
                                            ILBLightStatsMask stats,
                                            ILBLightStatOperation operation);

ILB_DLL_FUNCTION ILBStatus ILBSetLightRampEntry(ILBLightHandle light,
                                        float position,
                                        const ILBLinearRGB* value);

ILB_DLL_FUNCTION ILBStatus ILBSetLightProjectedTexture(ILBLightHandle light,
                                                       ILBTextureHandle texture);

ILB_DLL_FUNCTION ILBStatus ILBSetLightDisplayName(ILBLightHandle light, 
                                             ILBConstString displayName);

ILB_DLL_FUNCTION ILBStatus ILBSetSkyLightVolumeType(ILBLightHandle light, 
                                                    ILBLightVolumeType type);

ILB_DLL_FUNCTION ILBStatus ILBSetSkyLightTexture(ILBLightHandle light,
                                                 ILBTextureHandle texture);

ILB_DLL_FUNCTION ILBStatus ILBSetSkyLightTextureFilter(ILBLightHandle light, 
                                                       float filter);

ILB_DLL_FUNCTION ILBStatus ILBSetLightVolumeType(ILBLightHandle light, 
                                                 ILBLightVolumeType type);

ILB_DLL_FUNCTION ILBStatus ILBChangeLightType(ILBLightHandle light, 
                                              ILBLightType newType, 
                                              ILBLightHandle* newHandle);

ILB_DLL_FUNCTION ILBStatus ILBGetLightType(ILBLightHandle light,
                                           ILBLightType* type);

ILB_DLL_FUNCTION ILBStatus ILBGetLightTransform(ILBLightHandle light,
                                                ILBMatrix4x4* transform);

ILB_DLL_FUNCTION ILBStatus ILBGetLightName(ILBLightHandle light,
                                           ILBStringHandle* name);

ILB_DLL_FUNCTION ILBStatus ILBGetLightDisplayName(ILBLightHandle light,
                                                  ILBStringHandle* displayName);

ILB_DLL_FUNCTION ILBStatus ILBGetLightColor(ILBLightHandle light,
                                            ILBLinearRGB* color);

ILB_DLL_FUNCTION ILBStatus ILBGetLightIntensity(ILBLightHandle light, 
                                                float* intensity);

ILB_DLL_FUNCTION ILBStatus ILBGetLightCastShadows(ILBLightHandle light,
                                                  ILBBool* castShadows);

ILB_DLL_FUNCTION ILBStatus ILBGetLightShadowSamples(ILBLightHandle light,
                                                    int32* shadowSamples);

ILB_DLL_FUNCTION ILBStatus ILBGetLightFalloffType(ILBLightHandle light,
                                                  ILBFalloffType* type);

ILB_DLL_FUNCTION ILBStatus ILBGetLightMaxRangeFalloff(ILBLightHandle light, 
                                                      float* cutoff, 
                                                      float* exponent);

ILB_DLL_FUNCTION ILBStatus ILBGetLightExponentFalloff(ILBLightHandle light, 
                                                      float* cutoff, 
                                                      float* exponent, 
                                                      ILBBool* clamp);

ILB_DLL_FUNCTION ILBStatus ILBGetLightPolynomialFalloff(ILBLightHandle light, 
                                                        float* cutoff, 
                                                        float* constant, 
                                                        float* linear, 
                                                        float* quadratic, 
                                                        ILBBool* clamp);

ILB_DLL_FUNCTION ILBStatus ILBGetLightIntensityScale(ILBLightHandle light,
                                                     float* directScale,
                                                     float* indirectScale);

ILB_DLL_FUNCTION ILBStatus ILBGetLightStats(ILBLightHandle light,
                                            ILBLightStatsMask stats,
                                            ILBLightStatsMask* result);

ILB_DLL_FUNCTION ILBStatus ILBGetSpotlightCone(ILBLightHandle light, 
                                       float* angleRadians,
                                       float* penumbraAngleRadians,
                                       float* penumbraExponent);

ILB_DLL_FUNCTION ILBStatus ILBGetClippingPlanes(ILBLightHandle light, float* nearDistance, float* farDistance);

ILB_DLL_FUNCTION ILBStatus ILBGetShadowRadius(ILBLightHandle light, float* radius);

ILB_DLL_FUNCTION ILBStatus ILBGetShadowAngle(ILBLightHandle light, float* angleRadians);

ILB_DLL_FUNCTION ILBStatus ILBGetSkyLightVolumeType(ILBLightHandle light, ILBLightVolumeType* type);

ILB_DLL_FUNCTION ILBStatus ILBGetSkyLightTexture(ILBLightHandle light, ILBTextureHandle* texture);

ILB_DLL_FUNCTION ILBStatus ILBGetSkyLightTextureFilter(ILBLightHandle light, float* filter);

ILB_DLL_FUNCTION ILBStatus ILBGetLightVolumeType(ILBLightHandle light, ILBLightVolumeType* type);

ILB_DLL_FUNCTION ILBStatus ILBDeleteLightSource(ILBLightHandle light);

#ifdef __cplusplus
}
#endif // __cplusplus


#endif // BEASTLIGHTSOURCE_H