beastjob.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 BEASTJOB_H
#define BEASTJOB_H
#include "beastapitypes.h"

typedef enum {
    ILB_JS_SUCCESS = 0,

    ILB_JS_CANCELLED,

    ILB_JS_INVALID_LICENSE,

    ILB_JS_CMDLINE_ERROR,

    ILB_JS_CONFIG_ERROR,

    ILB_JS_CRASH,

    ILB_JS_OTHER_ERROR = 0x10000001

} ILBJobStatus;

typedef enum {
    ILB_ERS_RUN = 0,

    ILB_ERS_PAUSE

} ILBErnstRunningState;

typedef enum {
    ILB_SR_NO_DISPLAY = 0,

    ILB_SR_CLOSE_WHEN_DONE,

    ILB_SR_KEEP_OPEN
} ILBShowResults;

typedef enum {
    ILB_RD_FORCE_LOCAL = 0,

    ILB_RD_AUTODETECT,

    ILB_RD_FORCE_DISTRIBUTED
} ILBDistributionType;

typedef enum {
    ILB_UT_NEW_LIGHTSOURCE = 0,

    ILB_UT_UPDATE_LIGHTSOURCE,

    ILB_UT_DELETE_LIGHTSOURCE,

    ILB_UT_SCENE_INFO,

    ILB_UT_UPDATE_CAMERA,

    ILB_UT_UPDATE_TARGET,

    ILB_UT_UPDATE_TEXTURE,

    ILB_UT_UPDATE_VERTEX,
    ILB_UT_UPDATE_CAMERA_FRAME_BUFFER,

    ILB_UT_INVALIDATE_FRAMEBUFFER

} ILBUpdateType;

typedef enum {
    ILB_BM_CAMERA_FRUSTUM,

    ILB_BM_ENTIRE_LEVEL
} ILBErnstBakingModeType;

typedef enum {
    ILB_CM_NONE,

    ILB_CM_SOME,

    ILB_CM_ALL
} ILBCausticsModeType;

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

ILB_DLL_FUNCTION ILBStatus ILBCreateJob(ILBManagerHandle beastManager,
        ILBConstString uniqueName, 
        ILBSceneHandle scene, 
        ILBConstString jobXML, 
        ILBJobHandle* job);

ILB_DLL_FUNCTION ILBStatus ILBCreateErnstJob(ILBManagerHandle beastManager, 
    ILBConstString uniqueName, 
    ILBSceneHandle scene, 
    ILBConstString jobXML, 
    ILBJobHandle* job);

ILB_DLL_FUNCTION ILBStatus ILBCreateLiveErnstJob(ILBManagerHandle beastManager, 
    ILBConstString uniqueName, 
    ILBSceneHandle scene, 
    ILBJobHandle* job);

ILB_DLL_FUNCTION ILBStatus ILBCreateUVJob(ILBManagerHandle beastManager, 
    ILBConstString uniqueName, 
    ILBJobHandle* job);

ILB_DLL_FUNCTION ILBStatus ILBGetJobUpdate(ILBJobHandle job, 
    ILBBool* hasUpdate, 
    ILBJobUpdateHandle* updateHandle);

ILB_DLL_FUNCTION ILBStatus ILBGetJobUpdateType(ILBJobUpdateHandle update,
                                               ILBUpdateType* updateType);

ILB_DLL_FUNCTION ILBStatus ILBDestroyUpdate(ILBJobUpdateHandle update);

ILB_DLL_FUNCTION ILBStatus ILBGetUpdateLightSource(ILBJobUpdateHandle update, 
                                                   ILBLightHandle* light);

ILB_DLL_FUNCTION ILBStatus ILBGetUpdateSceneInfo(ILBJobUpdateHandle update, 
                                                   ILBSceneInfoHandle* sceneInfo);

ILB_DLL_FUNCTION ILBStatus ILBGetUpdateCamera(ILBJobUpdateHandle update, 
                                                   ILBCameraHandle* camera);

ILB_DLL_FUNCTION ILBStatus ILBGetUpdateTargetEntity(ILBJobUpdateHandle update,
                                                    ILBTargetEntityHandle* targetEntity);

ILB_DLL_FUNCTION ILBStatus ILBGetUpdateFramebuffer(ILBJobUpdateHandle update,
                                                    ILBFramebufferHandle* fb);

ILB_DLL_FUNCTION ILBStatus ILBGetUpdateInvalidateFramebuffer(ILBJobUpdateHandle update,
                                                             ILBTargetEntityHandle* te);


ILB_DLL_FUNCTION ILBStatus ILBDestroyJob(ILBJobHandle job);

ILB_DLL_FUNCTION ILBStatus ILBSetJobOutputPath(ILBJobHandle job, ILBConstString path);

ILB_DLL_FUNCTION ILBStatus ILBSetJobLocalProcessingThreads(ILBJobHandle job, int numLocalProcessingThreads);

ILB_DLL_FUNCTION ILBStatus ILBStartJob(ILBJobHandle job, ILBShowResults showResults, ILBDistributionType distribution);

ILB_DLL_FUNCTION ILBStatus ILBWaitJobDone(ILBJobHandle job, int32 timeout);

ILB_DLL_FUNCTION ILBStatus ILBIsJobRunning(ILBJobHandle job, ILBBool* result);

ILB_DLL_FUNCTION ILBStatus ILBIsJobCompleted(ILBJobHandle job, ILBBool* result);

ILB_DLL_FUNCTION ILBStatus ILBGetJobResult(ILBJobHandle job, ILBJobStatus* status);

ILB_DLL_FUNCTION ILBStatus ILBCancelJob(ILBJobHandle job);

ILB_DLL_FUNCTION ILBStatus ILBGetJobProgress(ILBJobHandle job, ILBStringHandle* jobName, int32* progress);

ILB_DLL_FUNCTION ILBStatus ILBJobHasNewProgress(ILBJobHandle job, ILBBool* newActivity, ILBBool* newProgress);

ILB_DLL_FUNCTION ILBStatus ILBExecuteBeast(ILBManagerHandle bm, 
                                   ILBJobHandle job,
                                   ILBShowResults showResults,
                                   ILBDistributionType distribution, 
                                   ILBJobStatus* status);

ILB_DLL_FUNCTION ILBStatus ILBSetErnstDirectIllumination(ILBJobHandle job, float illumination);

ILB_DLL_FUNCTION ILBStatus ILBSetErnstIndirectIllumination(ILBJobHandle job, float illumination);

ILB_DLL_FUNCTION ILBStatus ILBSetErnstVarianceThreshold(ILBJobHandle job, float threshold);

ILB_DLL_FUNCTION ILBStatus ILBSetErnstDisplayGamma(ILBJobHandle job, float displayGamma);

ILB_DLL_FUNCTION ILBStatus ILBSetErnstGIDepth(ILBJobHandle job, int minDepth, int maxDepth);

ILB_DLL_FUNCTION ILBStatus ILBSetErnstGIBakingMode(ILBJobHandle job, ILBErnstBakingModeType mode);

ILB_DLL_FUNCTION ILBStatus ILBSetErnstGIVarianceLimit(ILBJobHandle job, float vl);

ILB_DLL_FUNCTION ILBStatus ILBSetErnstGIDiffuseBoost(ILBJobHandle job, float boost);

ILB_DLL_FUNCTION ILBStatus ILBSetErnstGIEmissiveScale(ILBJobHandle job, float scale);

ILB_DLL_FUNCTION ILBStatus ILBSetErnstRunningState(ILBJobHandle job, ILBErnstRunningState state);

ILB_DLL_FUNCTION ILBStatus ILBSetJobRenderQuality(ILBJobHandle job, float quality);

ILB_DLL_FUNCTION ILBStatus ILBSetJobRenderSamples(ILBJobHandle job, int minSamples, int maxSamples, float varianceThreshold);

ILB_DLL_FUNCTION ILBStatus ILBSetJobRenderDepth(ILBJobHandle job, int minDepth, int maxDepth);

ILB_DLL_FUNCTION ILBStatus ILBSetCausticsMode(ILBJobHandle job, ILBCausticsModeType mode);

#ifdef __cplusplus
}
#endif // __cplusplus

#endif//BEASTJOB_H