OptixFunctionTable Struct Reference

#include <optix_function_table.h>

Public Attributes
Error handling
const char *(*	optixGetErrorName )(OptixResult result)
const char *(*	optixGetErrorString )(OptixResult result)
Device context
OptixResult(*	optixDeviceContextCreate )(CUcontext fromContext, const OptixDeviceContextOptions *options, OptixDeviceContext *context)
OptixResult(*	optixDeviceContextDestroy )(OptixDeviceContext context)
OptixResult(*	optixDeviceContextGetProperty )(OptixDeviceContext context, OptixDeviceProperty property, void *value, size_t sizeInBytes)
OptixResult(*	optixDeviceContextSetLogCallback )(OptixDeviceContext context, OptixLogCallback callbackFunction, void *callbackData, unsigned int callbackLevel)
OptixResult(*	optixDeviceContextSetCacheEnabled )(OptixDeviceContext context, int enabled)
OptixResult(*	optixDeviceContextSetCacheLocation )(OptixDeviceContext context, const char *location)
OptixResult(*	optixDeviceContextSetCacheDatabaseSizes )(OptixDeviceContext context, size_t lowWaterMark, size_t highWaterMark)
OptixResult(*	optixDeviceContextGetCacheEnabled )(OptixDeviceContext context, int *enabled)
OptixResult(*	optixDeviceContextGetCacheLocation )(OptixDeviceContext context, char *location, size_t locationSize)
OptixResult(*	optixDeviceContextGetCacheDatabaseSizes )(OptixDeviceContext context, size_t *lowWaterMark, size_t *highWaterMark)
Modules
OptixResult(*	optixModuleCreate )(OptixDeviceContext context, const OptixModuleCompileOptions *moduleCompileOptions, const OptixPipelineCompileOptions *pipelineCompileOptions, const char *input, size_t inputSize, char *logString, size_t *logStringSize, OptixModule *module)
OptixResult(*	optixModuleCreateWithTasks )(OptixDeviceContext context, const OptixModuleCompileOptions *moduleCompileOptions, const OptixPipelineCompileOptions *pipelineCompileOptions, const char *input, size_t inputSize, char *logString, size_t *logStringSize, OptixModule *module, OptixTask *firstTask)
OptixResult(*	optixModuleGetCompilationState )(OptixModule module, OptixModuleCompileState *state)
OptixResult(*	optixModuleDestroy )(OptixModule module)
OptixResult(*	optixBuiltinISModuleGet )(OptixDeviceContext context, const OptixModuleCompileOptions *moduleCompileOptions, const OptixPipelineCompileOptions *pipelineCompileOptions, const OptixBuiltinISOptions *builtinISOptions, OptixModule *builtinModule)
Tasks
OptixResult(*	optixTaskExecute )(OptixTask task, OptixTask *additionalTasks, unsigned int maxNumAdditionalTasks, unsigned int *numAdditionalTasksCreated)
Program groups
OptixResult(*	optixProgramGroupCreate )(OptixDeviceContext context, const OptixProgramGroupDesc *programDescriptions, unsigned int numProgramGroups, const OptixProgramGroupOptions *options, char *logString, size_t *logStringSize, OptixProgramGroup *programGroups)
OptixResult(*	optixProgramGroupDestroy )(OptixProgramGroup programGroup)
OptixResult(*	optixProgramGroupGetStackSize )(OptixProgramGroup programGroup, OptixStackSizes *stackSizes, OptixPipeline pipeline)
Pipeline
OptixResult(*	optixPipelineCreate )(OptixDeviceContext context, const OptixPipelineCompileOptions *pipelineCompileOptions, const OptixPipelineLinkOptions *pipelineLinkOptions, const OptixProgramGroup *programGroups, unsigned int numProgramGroups, char *logString, size_t *logStringSize, OptixPipeline *pipeline)
OptixResult(*	optixPipelineDestroy )(OptixPipeline pipeline)
OptixResult(*	optixPipelineSetStackSize )(OptixPipeline pipeline, unsigned int directCallableStackSizeFromTraversal, unsigned int directCallableStackSizeFromState, unsigned int continuationStackSize, unsigned int maxTraversableGraphDepth)
Acceleration structures
OptixResult(*	optixAccelComputeMemoryUsage )(OptixDeviceContext context, const OptixAccelBuildOptions *accelOptions, const OptixBuildInput *buildInputs, unsigned int numBuildInputs, OptixAccelBufferSizes *bufferSizes)
OptixResult(*	optixAccelBuild )(OptixDeviceContext context, CUstream stream, const OptixAccelBuildOptions *accelOptions, const OptixBuildInput *buildInputs, unsigned int numBuildInputs, CUdeviceptr tempBuffer, size_t tempBufferSizeInBytes, CUdeviceptr outputBuffer, size_t outputBufferSizeInBytes, OptixTraversableHandle *outputHandle, const OptixAccelEmitDesc *emittedProperties, unsigned int numEmittedProperties)
OptixResult(*	optixAccelGetRelocationInfo )(OptixDeviceContext context, OptixTraversableHandle handle, OptixRelocationInfo *info)
OptixResult(*	optixCheckRelocationCompatibility )(OptixDeviceContext context, const OptixRelocationInfo *info, int *compatible)
OptixResult(*	optixAccelRelocate )(OptixDeviceContext context, CUstream stream, const OptixRelocationInfo *info, const OptixRelocateInput *relocateInputs, size_t numRelocateInputs, CUdeviceptr targetAccel, size_t targetAccelSizeInBytes, OptixTraversableHandle *targetHandle)
OptixResult(*	optixAccelCompact )(OptixDeviceContext context, CUstream stream, OptixTraversableHandle inputHandle, CUdeviceptr outputBuffer, size_t outputBufferSizeInBytes, OptixTraversableHandle *outputHandle)
OptixResult(*	optixAccelEmitProperty )(OptixDeviceContext context, CUstream stream, OptixTraversableHandle handle, const OptixAccelEmitDesc *emittedProperty)
OptixResult(*	optixConvertPointerToTraversableHandle )(OptixDeviceContext onDevice, CUdeviceptr pointer, OptixTraversableType traversableType, OptixTraversableHandle *traversableHandle)
OptixResult(*	optixOpacityMicromapArrayComputeMemoryUsage )(OptixDeviceContext context, const OptixOpacityMicromapArrayBuildInput *buildInput, OptixMicromapBufferSizes *bufferSizes)
OptixResult(*	optixOpacityMicromapArrayBuild )(OptixDeviceContext context, CUstream stream, const OptixOpacityMicromapArrayBuildInput *buildInput, const OptixMicromapBuffers *buffers)
OptixResult(*	optixOpacityMicromapArrayGetRelocationInfo )(OptixDeviceContext context, CUdeviceptr opacityMicromapArray, OptixRelocationInfo *info)
OptixResult(*	optixOpacityMicromapArrayRelocate )(OptixDeviceContext context, CUstream stream, const OptixRelocationInfo *info, CUdeviceptr targetOpacityMicromapArray, size_t targetOpacityMicromapArraySizeInBytes)
OptixResult(*	optixDisplacementMicromapArrayComputeMemoryUsage )(OptixDeviceContext context, const OptixDisplacementMicromapArrayBuildInput *buildInput, OptixMicromapBufferSizes *bufferSizes)
OptixResult(*	optixDisplacementMicromapArrayBuild )(OptixDeviceContext context, CUstream stream, const OptixDisplacementMicromapArrayBuildInput *buildInput, const OptixMicromapBuffers *buffers)
Launch
OptixResult(*	optixSbtRecordPackHeader )(OptixProgramGroup programGroup, void *sbtRecordHeaderHostPointer)
OptixResult(*	optixLaunch )(OptixPipeline pipeline, CUstream stream, CUdeviceptr pipelineParams, size_t pipelineParamsSize, const OptixShaderBindingTable *sbt, unsigned int width, unsigned int height, unsigned int depth)
Denoiser
OptixResult(*	optixDenoiserCreate )(OptixDeviceContext context, OptixDenoiserModelKind modelKind, const OptixDenoiserOptions *options, OptixDenoiser *returnHandle)
OptixResult(*	optixDenoiserDestroy )(OptixDenoiser handle)
OptixResult(*	optixDenoiserComputeMemoryResources )(const OptixDenoiser handle, unsigned int maximumInputWidth, unsigned int maximumInputHeight, OptixDenoiserSizes *returnSizes)
OptixResult(*	optixDenoiserSetup )(OptixDenoiser denoiser, CUstream stream, unsigned int inputWidth, unsigned int inputHeight, CUdeviceptr state, size_t stateSizeInBytes, CUdeviceptr scratch, size_t scratchSizeInBytes)
OptixResult(*	optixDenoiserInvoke )(OptixDenoiser denoiser, CUstream stream, const OptixDenoiserParams *params, CUdeviceptr denoiserState, size_t denoiserStateSizeInBytes, const OptixDenoiserGuideLayer *guideLayer, const OptixDenoiserLayer *layers, unsigned int numLayers, unsigned int inputOffsetX, unsigned int inputOffsetY, CUdeviceptr scratch, size_t scratchSizeInBytes)
OptixResult(*	optixDenoiserComputeIntensity )(OptixDenoiser handle, CUstream stream, const OptixImage2D *inputImage, CUdeviceptr outputIntensity, CUdeviceptr scratch, size_t scratchSizeInBytes)
OptixResult(*	optixDenoiserComputeAverageColor )(OptixDenoiser handle, CUstream stream, const OptixImage2D *inputImage, CUdeviceptr outputAverageColor, CUdeviceptr scratch, size_t scratchSizeInBytes)
OptixResult(*	optixDenoiserCreateWithUserModel )(OptixDeviceContext context, const void *data, size_t dataSizeInBytes, OptixDenoiser *returnHandle)

Detailed Description

The function table containing all API functions.

See optixInit() and optixInitWithHandle().

Member Data Documentation

optixAccelBuild

OptixResult(* OptixFunctionTable::optixAccelBuild) (OptixDeviceContext context, CUstream stream, const OptixAccelBuildOptions *accelOptions, const OptixBuildInput *buildInputs, unsigned int numBuildInputs, CUdeviceptr tempBuffer, size_t tempBufferSizeInBytes, CUdeviceptr outputBuffer, size_t outputBufferSizeInBytes, OptixTraversableHandle *outputHandle, const OptixAccelEmitDesc *emittedProperties, unsigned int numEmittedProperties)

See optixAccelBuild().

optixAccelCompact

OptixResult(* OptixFunctionTable::optixAccelCompact) (OptixDeviceContext context, CUstream stream, OptixTraversableHandle inputHandle, CUdeviceptr outputBuffer, size_t outputBufferSizeInBytes, OptixTraversableHandle *outputHandle)

See optixAccelCompact().

optixAccelComputeMemoryUsage

OptixResult(* OptixFunctionTable::optixAccelComputeMemoryUsage) (OptixDeviceContext context, const OptixAccelBuildOptions *accelOptions, const OptixBuildInput *buildInputs, unsigned int numBuildInputs, OptixAccelBufferSizes *bufferSizes)

See optixAccelComputeMemoryUsage().

optixAccelEmitProperty

OptixResult(* OptixFunctionTable::optixAccelEmitProperty) (OptixDeviceContext context, CUstream stream, OptixTraversableHandle handle, const OptixAccelEmitDesc *emittedProperty)

See optixAccelComputeMemoryUsage().

optixAccelGetRelocationInfo

OptixResult(* OptixFunctionTable::optixAccelGetRelocationInfo) (OptixDeviceContext context, OptixTraversableHandle handle, OptixRelocationInfo *info)

See optixAccelGetRelocationInfo().

optixAccelRelocate

OptixResult(* OptixFunctionTable::optixAccelRelocate) (OptixDeviceContext context, CUstream stream, const OptixRelocationInfo *info, const OptixRelocateInput *relocateInputs, size_t numRelocateInputs, CUdeviceptr targetAccel, size_t targetAccelSizeInBytes, OptixTraversableHandle *targetHandle)

See optixAccelRelocate().

optixBuiltinISModuleGet

OptixResult(* OptixFunctionTable::optixBuiltinISModuleGet) (OptixDeviceContext context, const OptixModuleCompileOptions *moduleCompileOptions, const OptixPipelineCompileOptions *pipelineCompileOptions, const OptixBuiltinISOptions *builtinISOptions, OptixModule *builtinModule)

See optixBuiltinISModuleGet().

optixCheckRelocationCompatibility

OptixResult(* OptixFunctionTable::optixCheckRelocationCompatibility) (OptixDeviceContext context, const OptixRelocationInfo *info, int *compatible)

See optixCheckRelocationCompatibility().

optixConvertPointerToTraversableHandle

OptixResult(* OptixFunctionTable::optixConvertPointerToTraversableHandle) (OptixDeviceContext onDevice, CUdeviceptr pointer, OptixTraversableType traversableType, OptixTraversableHandle *traversableHandle)

See optixConvertPointerToTraversableHandle().

optixDenoiserComputeAverageColor

OptixResult(* OptixFunctionTable::optixDenoiserComputeAverageColor) (OptixDenoiser handle, CUstream stream, const OptixImage2D *inputImage, CUdeviceptr outputAverageColor, CUdeviceptr scratch, size_t scratchSizeInBytes)

See optixDenoiserComputeAverageColor().

optixDenoiserComputeIntensity

OptixResult(* OptixFunctionTable::optixDenoiserComputeIntensity) (OptixDenoiser handle, CUstream stream, const OptixImage2D *inputImage, CUdeviceptr outputIntensity, CUdeviceptr scratch, size_t scratchSizeInBytes)

See optixDenoiserComputeIntensity().

optixDenoiserComputeMemoryResources

OptixResult(* OptixFunctionTable::optixDenoiserComputeMemoryResources) (const OptixDenoiser handle, unsigned int maximumInputWidth, unsigned int maximumInputHeight, OptixDenoiserSizes *returnSizes)

See optixDenoiserComputeMemoryResources().

optixDenoiserCreate

OptixResult(* OptixFunctionTable::optixDenoiserCreate) (OptixDeviceContext context, OptixDenoiserModelKind modelKind, const OptixDenoiserOptions *options, OptixDenoiser *returnHandle)

See optixDenoiserCreate().

optixDenoiserCreateWithUserModel

OptixResult(* OptixFunctionTable::optixDenoiserCreateWithUserModel) (OptixDeviceContext context, const void *data, size_t dataSizeInBytes, OptixDenoiser *returnHandle)

See optixDenoiserCreateWithUserModel().

optixDenoiserDestroy

OptixResult(* OptixFunctionTable::optixDenoiserDestroy) (OptixDenoiser handle)

See optixDenoiserDestroy().

optixDenoiserInvoke

OptixResult(* OptixFunctionTable::optixDenoiserInvoke) (OptixDenoiser denoiser, CUstream stream, const OptixDenoiserParams *params, CUdeviceptr denoiserState, size_t denoiserStateSizeInBytes, const OptixDenoiserGuideLayer *guideLayer, const OptixDenoiserLayer *layers, unsigned int numLayers, unsigned int inputOffsetX, unsigned int inputOffsetY, CUdeviceptr scratch, size_t scratchSizeInBytes)

See optixDenoiserInvoke().

optixDenoiserSetup

OptixResult(* OptixFunctionTable::optixDenoiserSetup) (OptixDenoiser denoiser, CUstream stream, unsigned int inputWidth, unsigned int inputHeight, CUdeviceptr state, size_t stateSizeInBytes, CUdeviceptr scratch, size_t scratchSizeInBytes)

See optixDenoiserSetup().

optixDeviceContextCreate

OptixResult(* OptixFunctionTable::optixDeviceContextCreate) (CUcontext fromContext, const OptixDeviceContextOptions *options, OptixDeviceContext *context)

See optixDeviceContextCreate().

optixDeviceContextDestroy

OptixResult(* OptixFunctionTable::optixDeviceContextDestroy) (OptixDeviceContext context)

See optixDeviceContextDestroy().

optixDeviceContextGetCacheDatabaseSizes

OptixResult(* OptixFunctionTable::optixDeviceContextGetCacheDatabaseSizes) (OptixDeviceContext context, size_t *lowWaterMark, size_t *highWaterMark)

See optixDeviceContextGetCacheDatabaseSizes().

optixDeviceContextGetCacheEnabled

OptixResult(* OptixFunctionTable::optixDeviceContextGetCacheEnabled) (OptixDeviceContext context, int *enabled)

See optixDeviceContextGetCacheEnabled().

optixDeviceContextGetCacheLocation

OptixResult(* OptixFunctionTable::optixDeviceContextGetCacheLocation) (OptixDeviceContext context, char *location, size_t locationSize)

See optixDeviceContextGetCacheLocation().

optixDeviceContextGetProperty

OptixResult(* OptixFunctionTable::optixDeviceContextGetProperty) (OptixDeviceContext context, OptixDeviceProperty property, void *value, size_t sizeInBytes)

See optixDeviceContextGetProperty().

optixDeviceContextSetCacheDatabaseSizes

OptixResult(* OptixFunctionTable::optixDeviceContextSetCacheDatabaseSizes) (OptixDeviceContext context, size_t lowWaterMark, size_t highWaterMark)

See optixDeviceContextSetCacheDatabaseSizes().

optixDeviceContextSetCacheEnabled

OptixResult(* OptixFunctionTable::optixDeviceContextSetCacheEnabled) (OptixDeviceContext context, int enabled)

See optixDeviceContextSetCacheEnabled().

optixDeviceContextSetCacheLocation

OptixResult(* OptixFunctionTable::optixDeviceContextSetCacheLocation) (OptixDeviceContext context, const char *location)

See optixDeviceContextSetCacheLocation().

optixDeviceContextSetLogCallback

OptixResult(* OptixFunctionTable::optixDeviceContextSetLogCallback) (OptixDeviceContext context, OptixLogCallback callbackFunction, void *callbackData, unsigned int callbackLevel)

See optixDeviceContextSetLogCallback().

optixDisplacementMicromapArrayBuild

OptixResult(* OptixFunctionTable::optixDisplacementMicromapArrayBuild) (OptixDeviceContext context, CUstream stream, const OptixDisplacementMicromapArrayBuildInput *buildInput, const OptixMicromapBuffers *buffers)

See optixDisplacementMicromapArrayBuild().

optixDisplacementMicromapArrayComputeMemoryUsage

OptixResult(* OptixFunctionTable::optixDisplacementMicromapArrayComputeMemoryUsage) (OptixDeviceContext context, const OptixDisplacementMicromapArrayBuildInput *buildInput, OptixMicromapBufferSizes *bufferSizes)

See optixDisplacementMicromapArrayComputeMemoryUsage().

optixGetErrorName

const char *(* OptixFunctionTable::optixGetErrorName) (OptixResult result)

See optixGetErrorName().

optixGetErrorString

const char *(* OptixFunctionTable::optixGetErrorString) (OptixResult result)

See optixGetErrorString().

optixLaunch

OptixResult(* OptixFunctionTable::optixLaunch) (OptixPipeline pipeline, CUstream stream, CUdeviceptr pipelineParams, size_t pipelineParamsSize, const OptixShaderBindingTable *sbt, unsigned int width, unsigned int height, unsigned int depth)

See optixConvertPointerToTraversableHandle().

optixModuleCreate

OptixResult(* OptixFunctionTable::optixModuleCreate) (OptixDeviceContext context, const OptixModuleCompileOptions *moduleCompileOptions, const OptixPipelineCompileOptions *pipelineCompileOptions, const char *input, size_t inputSize, char *logString, size_t *logStringSize, OptixModule *module)

See optixModuleCreate().

optixModuleCreateWithTasks

OptixResult(* OptixFunctionTable::optixModuleCreateWithTasks) (OptixDeviceContext context, const OptixModuleCompileOptions *moduleCompileOptions, const OptixPipelineCompileOptions *pipelineCompileOptions, const char *input, size_t inputSize, char *logString, size_t *logStringSize, OptixModule *module, OptixTask *firstTask)

See optixModuleCreateWithTasks().

optixModuleDestroy

OptixResult(* OptixFunctionTable::optixModuleDestroy) (OptixModule module)

See optixModuleDestroy().

optixModuleGetCompilationState

OptixResult(* OptixFunctionTable::optixModuleGetCompilationState) (OptixModule module, OptixModuleCompileState *state)

See optixModuleGetCompilationState().

optixOpacityMicromapArrayBuild

OptixResult(* OptixFunctionTable::optixOpacityMicromapArrayBuild) (OptixDeviceContext context, CUstream stream, const OptixOpacityMicromapArrayBuildInput *buildInput, const OptixMicromapBuffers *buffers)

See optixOpacityMicromapArrayBuild().

optixOpacityMicromapArrayComputeMemoryUsage

OptixResult(* OptixFunctionTable::optixOpacityMicromapArrayComputeMemoryUsage) (OptixDeviceContext context, const OptixOpacityMicromapArrayBuildInput *buildInput, OptixMicromapBufferSizes *bufferSizes)

See optixOpacityMicromapArrayComputeMemoryUsage().

optixOpacityMicromapArrayGetRelocationInfo

OptixResult(* OptixFunctionTable::optixOpacityMicromapArrayGetRelocationInfo) (OptixDeviceContext context, CUdeviceptr opacityMicromapArray, OptixRelocationInfo *info)

See optixOpacityMicromapArrayGetRelocationInfo().

optixOpacityMicromapArrayRelocate

OptixResult(* OptixFunctionTable::optixOpacityMicromapArrayRelocate) (OptixDeviceContext context, CUstream stream, const OptixRelocationInfo *info, CUdeviceptr targetOpacityMicromapArray, size_t targetOpacityMicromapArraySizeInBytes)

See optixOpacityMicromapArrayRelocate().

optixPipelineCreate

OptixResult(* OptixFunctionTable::optixPipelineCreate) (OptixDeviceContext context, const OptixPipelineCompileOptions *pipelineCompileOptions, const OptixPipelineLinkOptions *pipelineLinkOptions, const OptixProgramGroup *programGroups, unsigned int numProgramGroups, char *logString, size_t *logStringSize, OptixPipeline *pipeline)

See optixPipelineCreate().

optixPipelineDestroy

OptixResult(* OptixFunctionTable::optixPipelineDestroy) (OptixPipeline pipeline)

See optixPipelineDestroy().

optixPipelineSetStackSize

OptixResult(* OptixFunctionTable::optixPipelineSetStackSize) (OptixPipeline pipeline, unsigned int directCallableStackSizeFromTraversal, unsigned int directCallableStackSizeFromState, unsigned int continuationStackSize, unsigned int maxTraversableGraphDepth)

See optixPipelineSetStackSize().

optixProgramGroupCreate

OptixResult(* OptixFunctionTable::optixProgramGroupCreate) (OptixDeviceContext context, const OptixProgramGroupDesc *programDescriptions, unsigned int numProgramGroups, const OptixProgramGroupOptions *options, char *logString, size_t *logStringSize, OptixProgramGroup *programGroups)

See optixProgramGroupCreate().

optixProgramGroupDestroy

OptixResult(* OptixFunctionTable::optixProgramGroupDestroy) (OptixProgramGroup programGroup)

See optixProgramGroupDestroy().

optixProgramGroupGetStackSize

OptixResult(* OptixFunctionTable::optixProgramGroupGetStackSize) (OptixProgramGroup programGroup, OptixStackSizes *stackSizes, OptixPipeline pipeline)

See optixProgramGroupGetStackSize().

optixSbtRecordPackHeader

OptixResult(* OptixFunctionTable::optixSbtRecordPackHeader) (OptixProgramGroup programGroup, void *sbtRecordHeaderHostPointer)

See optixConvertPointerToTraversableHandle().

optixTaskExecute

OptixResult(* OptixFunctionTable::optixTaskExecute) (OptixTask task, OptixTask *additionalTasks, unsigned int maxNumAdditionalTasks, unsigned int *numAdditionalTasksCreated)

See optixTaskExecute().