ai_device.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_string.h>
#include <ai_array.h>
#include <ai_render.h>
 
enum AtDeviceType
{
   AI_DEVICE_TYPE_CPU  = 0,   
   AI_DEVICE_TYPE_GPU  = 1    
};
 
enum AtDeviceMemory
{
   AI_DEVICE_MEMORY_TOTAL,   
   AI_DEVICE_MEMORY_FREE,    
   AI_DEVICE_MEMORY_USED     
};
 
enum class AtDeviceSelectErrorCode
{
   SUCCESS,                  
   FAILURE_NO_DEVICES_FOUND, 
   FAILURE_NAME,             
   FAILURE_MEMORY,           
   FAILURE_INVALID_ID,       
   FAILURE_UNSUPPORTED,      
   FAILURE_UNKNOWN           
};
 
AI_API bool AiDeviceTypeIsSupported(AtDeviceType device_type, AtString& reason);
 
AI_API AtDeviceSelectErrorCode AiDeviceSelect(AtRenderSession* render_session, AtDeviceType device_type, const AtArray* device_ids);
 
AI_API AtDeviceSelectErrorCode AiDeviceAutoSelect(AtRenderSession* render_session);
 
AI_API AtDeviceType AiDeviceGetSelectedType(const AtRenderSession* render_session);
 
AI_API const AtArray* AiDeviceGetSelectedIds(const AtRenderSession* render_session, AtDeviceType device_type);
 
AI_API unsigned int AiDeviceGetCount(AtDeviceType device_type);
 
AI_API const AtArray* AiDeviceGetIds(AtDeviceType device_type);
 
AI_API AtString AiDeviceGetName(AtDeviceType device_type, unsigned int device_id);
 
AI_API unsigned int AiDeviceGetMemoryMB(AtDeviceType device_type, unsigned int device_id, AtDeviceMemory memory);
 
typedef void (*AtGPUCachePopulateCallback)(void* user_ptr, AtRenderStatus status, float fraction_done, const char* msg);
 
enum AtGPUCachePopulateMode
{
   AI_GPU_CACHE_POPULATE_BLOCKING,
   AI_GPU_CACHE_POPULATE_NON_BLOCKING
};
 
AI_API void AiGPUCacheSetDirectory(const char* dir_path);
 
AI_API AtString AiGPUCacheGetDirectory();
/*\}*/