Typedefs | Enumerations | Functions
ai_device.h File Reference

API for managing gpu rendering. More...

#include "ai_api.h"
#include <ai_string.h>
#include <ai_array.h>
#include <ai_render.h>

Go to the source code of this file.

Typedefs

typedef void(* AtGPUCachePopulateCallback) (void *user_ptr, AtRenderStatus status, float fraction_done, const char *msg)
 GPU cache population report callback. More...
 

Enumerations

enum  AtDeviceType { AI_DEVICE_TYPE_CPU = 0, AI_DEVICE_TYPE_GPU = 1 }
 Device types. More...
 
enum  AtDeviceMemory { AI_DEVICE_MEMORY_TOTAL, AI_DEVICE_MEMORY_FREE, AI_DEVICE_MEMORY_USED }
 Queriable memory attributes. More...
 
enum  AtGPUCachePopulateMode { AI_GPU_CACHE_POPULATE_BLOCKING, AI_GPU_CACHE_POPULATE_NON_BLOCKING }
 

Functions

AI_API bool AiDeviceTypeIsSupported (AtDeviceType device_type, AtString &reason)
 Returns if a given device is supported on the current system. More...
 
AI_API int AiDeviceSelect (AtDeviceType device_type, const AtArray *device_ids)
 Select render device. More...
 
AI_API int AiDeviceAutoSelect ()
 Automatically select render device based on options. More...
 
AI_API AtDeviceType AiDeviceGetSelectedType ()
 Returns the currently selected render device type. More...
 
AI_API const AtArray * AiDeviceGetSelectedIds (AtDeviceType device_type)
 Returns the currently selected devices ids of a device type. More...
 
AI_API unsigned int AiDeviceGetCount (AtDeviceType device_type)
 Returns the number of available devices of a given type. More...
 
AI_API const AtArray * AiDeviceGetIds (AtDeviceType device_type)
 Returns the ids of available devices of a given type. More...
 
AI_API AtString AiDeviceGetName (AtDeviceType device_type, unsigned int device_id)
 Returns the name of a device. More...
 
AI_API unsigned int AiDeviceGetMemoryMB (AtDeviceType device_type, unsigned int device_id, AtDeviceMemory memory)
 Returns memory information of a device. More...
 
AI_API AtRenderErrorCode AiGPUCachePopulate (AtGPUCachePopulateMode mode=AI_GPU_CACHE_POPULATE_NON_BLOCKING, unsigned int num_proc=0, AtGPUCachePopulateCallback report_callback=NULL, void *user_ptr=NULL)
 Pre-populates the GPU program cache. More...
 
AI_API AtRenderStatus AiGPUCachePopulateStatus (float *fraction_done)
 Poll for the current status of the GPU cache population. More...
 
AI_API float AiGPUCachePopulateRemainingSeconds ()
 Estimate for how many more seconds remain for the GPU cache population.
 
AI_API void AiGPUCachePopulateTerminate ()
 Request immediate termination of the GPU cache population. More...
 
AI_API void AiGPUCacheSetDirectory (const char *dir_path)
 Set the directory where the OptiX cache will be stored. More...
 
AI_API AtString AiGPUCacheGetDirectory ()
 Get the directory specified via AiGPUCacheSetDirectory (or if not specified, the default) More...
 

Detailed Description

API for managing gpu rendering.


© 2020 Autodesk, Inc. · All rights reserved · www.arnoldrenderer.com