ai_render.h

Go to the documentation of this file.

// Copyright 2023 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.
 
#pragma once
#include "ai_api.h"
#include "ai_array.h"
#include "ai_string.h"
#include <stddef.h> // NULL
#include <stdint.h> // uint32_t etc
 
// forward declares
struct AtNode;
class AtRenderSession;
class AtUniverse;
 
enum AtRenderMode
{
   AI_RENDER_MODE_CAMERA,  
   AI_RENDER_MODE_FREE     
};
 
enum AtRenderErrorCode
{
   AI_SUCCESS,                   
   AI_ABORT,                     
   AI_ERROR_NO_CAMERA,           
   AI_ERROR_BAD_CAMERA,          
   AI_ERROR_VALIDATION,          
   AI_ERROR_RENDER_REGION,       
   AI_INTERRUPT,                 
   AI_ERROR_NO_OUTPUTS,          
   AI_ERROR_UNAVAILABLE_DEVICE,  
   AI_ERROR                      
};
 
enum AtSessionMode
{
   AI_SESSION_BATCH,       
   AI_SESSION_INTERACTIVE  
};
 
enum AtDisplayOutput
{
   AI_DISPLAY_OUTPUT_NONE,                 
   AI_DISPLAY_OUTPUT_INTERACTIVE,          
   AI_DISPLAY_OUTPUT_PARTIAL_INTERACTIVE,  
   AI_DISPLAY_OUTPUT_ALL                   
};
 
enum AtRenderStatus
{
   AI_RENDER_STATUS_NOT_STARTED,  
   AI_RENDER_STATUS_PAUSED,       
   AI_RENDER_STATUS_RESTARTING,   
   AI_RENDER_STATUS_RENDERING,    
   AI_RENDER_STATUS_FINISHED,     
   AI_RENDER_STATUS_FAILED        
};
 
enum AtRenderUpdateType
{
   AI_RENDER_UPDATE_INTERRUPT,    
   AI_RENDER_UPDATE_BEFORE_PASS,  
   AI_RENDER_UPDATE_DURING_PASS,  
   AI_RENDER_UPDATE_AFTER_PASS,   
   AI_RENDER_UPDATE_FINISHED,     
   AI_RENDER_UPDATE_ERROR,        
   AI_RENDER_UPDATE_IMAGERS       
};
 
struct AtRenderUpdateInfo
{
   AtRenderSession* render_session;          
   AtDisplayOutput outputs_to_display;       
   uint32_t pass_index;                      
   uint32_t total_passes;                    
   int32_t current_AA_samples;               
   int32_t current_AA_samples_max;           
   int32_t current_GI_diffuse_samples;       
   int32_t current_GI_specular_samples;      
   int32_t current_GI_transmission_samples;  
   int32_t current_GI_sss_samples;           
   int32_t current_GI_volume_samples;        
};
 
typedef AtRenderStatus (*AtRenderUpdateCallback)(void *private_data, AtRenderUpdateType update_type, const AtRenderUpdateInfo *update_info);
 
AI_API void AiBegin(AtSessionMode mode = AI_SESSION_BATCH);
AI_API void AiEnd();
AI_API bool AiArnoldIsActive();
 
AI_API AtRenderSession* AiRenderSession(AtUniverse* universe, AtSessionMode mode = AI_SESSION_BATCH);
AI_API AtUniverse* AiRenderSessionGetUniverse(const AtRenderSession* render_session);
AI_API AI_PURE const AtNode* AiRenderSessionGetOptions(const AtRenderSession* render_session);
AI_API void AiRenderSessionDestroy(AtRenderSession* render_session);
 
AI_API AtSessionMode AiGetSessionMode(const AtRenderSession* render_session);
 
AI_API void AiRenderAddInteractiveOutput(AtRenderSession* render_session, uint32_t output_index);
AI_API bool AiRenderIsInteractiveOutput(AtRenderSession* render_session, uint32_t output_index);
AI_API bool AiRenderRemoveInteractiveOutput(AtRenderSession* render_session, uint32_t output_index);
AI_API void AiRenderRemoveAllInteractiveOutputs(AtRenderSession* render_session);
 
AI_API bool AiRenderSetHintBool(AtRenderSession* render_session, AtString hint, bool value);
AI_API bool AiRenderSetHintInt(AtRenderSession* render_session, AtString hint, int32_t value);
AI_API bool AiRenderSetHintFlt(AtRenderSession* render_session, AtString hint, float value);
AI_API bool AiRenderSetHintStr(AtRenderSession* render_session, AtString hint, AtString value);
AI_API bool AiRenderSetHintArray(AtRenderSession* render_session, AtString hint, AtArray *value);
AI_API bool AiRenderGetHintBool(const AtRenderSession* render_session, AtString hint, bool& value);
AI_API bool AiRenderGetHintInt(const AtRenderSession* render_session, AtString hint, int32_t& value);
AI_API bool AiRenderGetHintFlt(const AtRenderSession* render_session, AtString hint, float& value);
AI_API bool AiRenderGetHintStr(const AtRenderSession* render_session, AtString hint, AtString& value);
AI_API bool AiRenderGetHintArray(const AtRenderSession* render_session, AtString hint, const AtArray*& value);
 
AI_API AtRenderErrorCode AiRenderBegin(AtRenderSession* render_session, AtRenderMode mode = AI_RENDER_MODE_CAMERA, AtRenderUpdateCallback update_callback = NULL, void* callback_private_data = NULL);
AI_API AtRenderErrorCode AiRenderEnd(AtRenderSession* render_session);
AI_API AtRenderStatus    AiRenderGetStatus(const AtRenderSession* render_session);
AI_API void              AiRenderInterrupt(AtRenderSession* render_session, AtBlockingCall blocking = AI_NON_BLOCKING);
AI_API void              AiRenderAbort(AtRenderSession* render_session, AtBlockingCall blocking = AI_NON_BLOCKING);
AI_API void              AiRenderResume(AtRenderSession* render_session);
AI_API void              AiRenderRestart(AtRenderSession* render_session);
AI_API bool              AiRenderIsAnyActive();
AI_API AtRenderErrorCode AiRender(AtRenderSession* render_session, AtRenderMode mode = AI_RENDER_MODE_CAMERA);
 
/*\}*/