File size: 20,119 Bytes
7873319 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 | /*
* Copyright (c) 2021 NVIDIA Corporation. All rights reserved.
*
* NVIDIA Corporation and its licensors retain all intellectual property and proprietary
* rights in and to this software, related documentation and any modifications thereto.
* Any use, reproduction, disclosure or distribution of this software and related
* documentation without an express license agreement from NVIDIA Corporation is strictly
* prohibited.
*
* TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THIS SOFTWARE IS PROVIDED *AS IS*
* AND NVIDIA AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES, EITHER EXPRESS OR IMPLIED,
* INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE. IN NO EVENT SHALL NVIDIA OR ITS SUPPLIERS BE LIABLE FOR ANY
* SPECIAL, INCIDENTAL, INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT
* LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF
* BUSINESS INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
* INABILITY TO USE THIS SOFTWARE, EVEN IF NVIDIA HAS BEEN ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGES
*/
/// @file
/// @author NVIDIA Corporation
/// @brief OptiX public API header
#ifndef __optix_optix_function_table_h__
#define __optix_optix_function_table_h__
/// The OptiX ABI version.
#define OPTIX_ABI_VERSION 68
#ifndef OPTIX_DEFINE_ABI_VERSION_ONLY
#include "optix_types.h"
#if !defined( OPTIX_DONT_INCLUDE_CUDA )
// If OPTIX_DONT_INCLUDE_CUDA is defined, cuda driver types must be defined through other
// means before including optix headers.
#include <cuda.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/// \defgroup optix_function_table Function Table
/// \brief OptiX Function Table
/** \addtogroup optix_function_table
@{
*/
/// The function table containing all API functions.
///
/// See #optixInit() and #optixInitWithHandle().
typedef struct OptixFunctionTable
{
/// \name Error handling
//@ {
/// See ::optixGetErrorName().
const char* ( *optixGetErrorName )( OptixResult result );
/// See ::optixGetErrorString().
const char* ( *optixGetErrorString )( OptixResult result );
//@ }
/// \name Device context
//@ {
/// See ::optixDeviceContextCreate().
OptixResult ( *optixDeviceContextCreate )( CUcontext fromContext, const OptixDeviceContextOptions* options, OptixDeviceContext* context );
/// See ::optixDeviceContextDestroy().
OptixResult ( *optixDeviceContextDestroy )( OptixDeviceContext context );
/// See ::optixDeviceContextGetProperty().
OptixResult ( *optixDeviceContextGetProperty )( OptixDeviceContext context, OptixDeviceProperty property, void* value, size_t sizeInBytes );
/// See ::optixDeviceContextSetLogCallback().
OptixResult ( *optixDeviceContextSetLogCallback )( OptixDeviceContext context,
OptixLogCallback callbackFunction,
void* callbackData,
unsigned int callbackLevel );
/// See ::optixDeviceContextSetCacheEnabled().
OptixResult ( *optixDeviceContextSetCacheEnabled )( OptixDeviceContext context, int enabled );
/// See ::optixDeviceContextSetCacheLocation().
OptixResult ( *optixDeviceContextSetCacheLocation )( OptixDeviceContext context, const char* location );
/// See ::optixDeviceContextSetCacheDatabaseSizes().
OptixResult ( *optixDeviceContextSetCacheDatabaseSizes )( OptixDeviceContext context, size_t lowWaterMark, size_t highWaterMark );
/// See ::optixDeviceContextGetCacheEnabled().
OptixResult ( *optixDeviceContextGetCacheEnabled )( OptixDeviceContext context, int* enabled );
/// See ::optixDeviceContextGetCacheLocation().
OptixResult ( *optixDeviceContextGetCacheLocation )( OptixDeviceContext context, char* location, size_t locationSize );
/// See ::optixDeviceContextGetCacheDatabaseSizes().
OptixResult ( *optixDeviceContextGetCacheDatabaseSizes )( OptixDeviceContext context, size_t* lowWaterMark, size_t* highWaterMark );
//@ }
/// \name Modules
//@ {
/// See ::optixModuleCreateFromPTX().
OptixResult ( *optixModuleCreateFromPTX )( OptixDeviceContext context,
const OptixModuleCompileOptions* moduleCompileOptions,
const OptixPipelineCompileOptions* pipelineCompileOptions,
const char* PTX,
size_t PTXsize,
char* logString,
size_t* logStringSize,
OptixModule* module );
/// See ::optixModuleCreateFromPTXWithTasks().
OptixResult ( *optixModuleCreateFromPTXWithTasks )( OptixDeviceContext context,
const OptixModuleCompileOptions* moduleCompileOptions,
const OptixPipelineCompileOptions* pipelineCompileOptions,
const char* PTX,
size_t PTXsize,
char* logString,
size_t* logStringSize,
OptixModule* module,
OptixTask* firstTask );
/// See ::optixModuleGetCompilationState().
OptixResult ( *optixModuleGetCompilationState )( OptixModule module, OptixModuleCompileState* state );
/// See ::optixModuleDestroy().
OptixResult ( *optixModuleDestroy )( OptixModule module );
/// See ::optixBuiltinISModuleGet().
OptixResult( *optixBuiltinISModuleGet )( OptixDeviceContext context,
const OptixModuleCompileOptions* moduleCompileOptions,
const OptixPipelineCompileOptions* pipelineCompileOptions,
const OptixBuiltinISOptions* builtinISOptions,
OptixModule* builtinModule);
//@ }
/// \name Tasks
//@ {
/// See ::optixTaskExecute().
OptixResult ( *optixTaskExecute )( OptixTask task,
OptixTask* additionalTasks,
unsigned int maxNumAdditionalTasks,
unsigned int* numAdditionalTasksCreated );
//@ }
/// \name Program groups
//@ {
/// See ::optixProgramGroupCreate().
OptixResult ( *optixProgramGroupCreate )( OptixDeviceContext context,
const OptixProgramGroupDesc* programDescriptions,
unsigned int numProgramGroups,
const OptixProgramGroupOptions* options,
char* logString,
size_t* logStringSize,
OptixProgramGroup* programGroups );
/// See ::optixProgramGroupDestroy().
OptixResult ( *optixProgramGroupDestroy )( OptixProgramGroup programGroup );
/// See ::optixProgramGroupGetStackSize().
OptixResult ( *optixProgramGroupGetStackSize )( OptixProgramGroup programGroup, OptixStackSizes* stackSizes );
//@ }
/// \name Pipeline
//@ {
/// See ::optixPipelineCreate().
OptixResult ( *optixPipelineCreate )( OptixDeviceContext context,
const OptixPipelineCompileOptions* pipelineCompileOptions,
const OptixPipelineLinkOptions* pipelineLinkOptions,
const OptixProgramGroup* programGroups,
unsigned int numProgramGroups,
char* logString,
size_t* logStringSize,
OptixPipeline* pipeline );
/// See ::optixPipelineDestroy().
OptixResult ( *optixPipelineDestroy )( OptixPipeline pipeline );
/// See ::optixPipelineSetStackSize().
OptixResult ( *optixPipelineSetStackSize )( OptixPipeline pipeline,
unsigned int directCallableStackSizeFromTraversal,
unsigned int directCallableStackSizeFromState,
unsigned int continuationStackSize,
unsigned int maxTraversableGraphDepth );
//@ }
/// \name Acceleration structures
//@ {
/// See ::optixAccelComputeMemoryUsage().
OptixResult ( *optixAccelComputeMemoryUsage )( OptixDeviceContext context,
const OptixAccelBuildOptions* accelOptions,
const OptixBuildInput* buildInputs,
unsigned int numBuildInputs,
OptixAccelBufferSizes* bufferSizes );
/// See ::optixAccelBuild().
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 );
/// See ::optixAccelGetRelocationInfo().
OptixResult ( *optixAccelGetRelocationInfo )( OptixDeviceContext context, OptixTraversableHandle handle, OptixRelocationInfo* info );
/// See ::optixCheckRelocationCompatibility().
OptixResult ( *optixCheckRelocationCompatibility )( OptixDeviceContext context,
const OptixRelocationInfo* info,
int* compatible );
/// See ::optixAccelRelocate().
OptixResult ( *optixAccelRelocate )( OptixDeviceContext context,
CUstream stream,
const OptixRelocationInfo* info,
const OptixRelocateInput* relocateInputs,
size_t numRelocateInputs,
CUdeviceptr targetAccel,
size_t targetAccelSizeInBytes,
OptixTraversableHandle* targetHandle );
/// See ::optixAccelCompact().
OptixResult ( *optixAccelCompact )( OptixDeviceContext context,
CUstream stream,
OptixTraversableHandle inputHandle,
CUdeviceptr outputBuffer,
size_t outputBufferSizeInBytes,
OptixTraversableHandle* outputHandle );
/// See ::optixConvertPointerToTraversableHandle().
OptixResult ( *optixConvertPointerToTraversableHandle )( OptixDeviceContext onDevice,
CUdeviceptr pointer,
OptixTraversableType traversableType,
OptixTraversableHandle* traversableHandle );
/// See ::optixOpacityMicromapArrayComputeMemoryUsage().
OptixResult ( *optixOpacityMicromapArrayComputeMemoryUsage )( OptixDeviceContext context,
const OptixOpacityMicromapArrayBuildInput* buildInput,
OptixMicromapBufferSizes* bufferSizes );
/// See ::optixOpacityMicromapArrayBuild().
OptixResult ( *optixOpacityMicromapArrayBuild )( OptixDeviceContext context,
CUstream stream,
const OptixOpacityMicromapArrayBuildInput* buildInput,
const OptixMicromapBuffers* buffers );
/// See ::optixOpacityMicromapArrayGetRelocationInfo().
OptixResult ( *optixOpacityMicromapArrayGetRelocationInfo )( OptixDeviceContext context,
CUdeviceptr opacityMicromapArray,
OptixRelocationInfo* info );
/// See ::optixOpacityMicromapArrayRelocate().
OptixResult ( *optixOpacityMicromapArrayRelocate )( OptixDeviceContext context,
CUstream stream,
const OptixRelocationInfo* info,
CUdeviceptr targetOpacityMicromapArray,
size_t targetOpacityMicromapArraySizeInBytes );
void ( *reserved1 )( void );
void ( *reserved2 )( void );
//@ }
/// \name Launch
//@ {
/// See ::optixConvertPointerToTraversableHandle().
OptixResult ( *optixSbtRecordPackHeader )( OptixProgramGroup programGroup, void* sbtRecordHeaderHostPointer );
/// See ::optixConvertPointerToTraversableHandle().
OptixResult ( *optixLaunch )( OptixPipeline pipeline,
CUstream stream,
CUdeviceptr pipelineParams,
size_t pipelineParamsSize,
const OptixShaderBindingTable* sbt,
unsigned int width,
unsigned int height,
unsigned int depth );
//@ }
/// \name Denoiser
//@ {
/// See ::optixDenoiserCreate().
OptixResult ( *optixDenoiserCreate )( OptixDeviceContext context, OptixDenoiserModelKind modelKind, const OptixDenoiserOptions* options, OptixDenoiser* returnHandle );
/// See ::optixDenoiserDestroy().
OptixResult ( *optixDenoiserDestroy )( OptixDenoiser handle );
/// See ::optixDenoiserComputeMemoryResources().
OptixResult ( *optixDenoiserComputeMemoryResources )( const OptixDenoiser handle,
unsigned int maximumInputWidth,
unsigned int maximumInputHeight,
OptixDenoiserSizes* returnSizes );
/// See ::optixDenoiserSetup().
OptixResult ( *optixDenoiserSetup )( OptixDenoiser denoiser,
CUstream stream,
unsigned int inputWidth,
unsigned int inputHeight,
CUdeviceptr state,
size_t stateSizeInBytes,
CUdeviceptr scratch,
size_t scratchSizeInBytes );
/// See ::optixDenoiserInvoke().
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 );
/// See ::optixDenoiserComputeIntensity().
OptixResult ( *optixDenoiserComputeIntensity )( OptixDenoiser handle,
CUstream stream,
const OptixImage2D* inputImage,
CUdeviceptr outputIntensity,
CUdeviceptr scratch,
size_t scratchSizeInBytes );
/// See ::optixDenoiserComputeAverageColor().
OptixResult ( *optixDenoiserComputeAverageColor )( OptixDenoiser handle,
CUstream stream,
const OptixImage2D* inputImage,
CUdeviceptr outputAverageColor,
CUdeviceptr scratch,
size_t scratchSizeInBytes );
/// See ::optixDenoiserCreateWithUserModel().
OptixResult ( *optixDenoiserCreateWithUserModel )( OptixDeviceContext context, const void * data, size_t dataSizeInBytes, OptixDenoiser* returnHandle );
//@ }
} OptixFunctionTable;
/*@}*/ // end group optix_function_table
#ifdef __cplusplus
}
#endif
#endif /* OPTIX_DEFINE_ABI_VERSION_ONLY */
#endif /* __optix_optix_function_table_h__ */
|