owl_host.h File Reference

#include <cuda.h>
#include <driver_types.h>
#include <optix.h>
#include <sys/types.h>
#include <stdint.h>

Go to the source code of this file.

Classes
struct	_OWL_int2
struct	_OWL_uint2
struct	_OWL_long2
struct	_OWL_ulong2
struct	_OWL_float2
struct	_OWL_double2
struct	_OWL_int3
struct	_OWL_uint3
struct	_OWL_long3
struct	_OWL_ulong3
struct	_OWL_float3
struct	_OWL_double3
struct	_OWL_int4
struct	_OWL_uint4
struct	_OWL_long4
struct	_OWL_ulong4
struct	_OWL_float4
struct	_OWL_double4
struct	_OWL_affine3f
struct	_OWLVarDecl
struct	_OWLDeviceBuffer2D

Macros
#define	OWL_DLL_EXPORT
#define	OWL_DLL_IMPORT
#define	OWL_IF_CPP(a)   /* drop it */
#define	OWL_API   /* bla */
#define	OWL_OFFSETOF(type, member)
#define	OWL_USER_TYPE(userType)   ((OWLDataType)(OWL_USER_TYPE_BEGIN+sizeof(userType)))
#define	OWL_ALL_RAY_TYPES   -1
#define	_OWL_SET_HELPER(stype, abb)
#define	_OWL_SET_HELPERS_C(OType, stype, abb)
#define	_OWL_SET_HELPERS_CPP(OType, stype, abb)   /* ignore in C99 mode */
#define	_OWL_SET_HELPERS(Type)

Typedefs
typedef float	OWL_float
typedef double	OWL_double
typedef int32_t	OWL_int
typedef uint32_t	OWL_uint
typedef int64_t	OWL_long
typedef uint64_t	OWL_ulong
typedef struct _OWL_int2	owl2i
typedef struct _OWL_uint2	owl2ui
typedef struct _OWL_long2	owl2l
typedef struct _OWL_ulong2	owl2ul
typedef struct _OWL_float2	owl2f
typedef struct _OWL_double2	owl2d
typedef struct _OWL_int3	owl3i
typedef struct _OWL_uint3	owl3ui
typedef struct _OWL_long3	owl3l
typedef struct _OWL_ulong3	owl3ul
typedef struct _OWL_float3	owl3f
typedef struct _OWL_double3	owl3d
typedef struct _OWL_int4	owl4i
typedef struct _OWL_uint4	owl4ui
typedef struct _OWL_long4	owl4l
typedef struct _OWL_ulong4	owl4ul
typedef struct _OWL_float4	owl4f
typedef struct _OWL_double4	owl4d
typedef struct _OWL_affine3f	owl4x3f
typedef struct _OWLVarDecl	OWLVarDecl
typedef OptixTraversableHandle	OWLDeviceTraversable
typedef struct _OWLDeviceBuffer2D	OWLDeviceBuffer2D
typedef struct _OWLContext *	OWLContext
typedef struct _OWLBuffer *	OWLBuffer
typedef struct _OWLTexture *	OWLTexture
typedef struct _OWLGeom *	OWLGeom
typedef struct _OWLGeomType *	OWLGeomType
typedef struct _OWLVariable *	OWLVariable
typedef struct _OWLModule *	OWLModule
typedef struct _OWLGroup *	OWLGroup
typedef struct _OWLRayGen *	OWLRayGen
typedef struct _OWLMissProg *	OWLMissProg
typedef struct _OWLLaunchParams *	OWLLaunchParams
typedef struct _OWLLaunchParams *	OWLParams
typedef struct _OWLLaunchParams *	OWLGlobals

Enumerations
enum	OWLMatrixFormat { OWL_MATRIX_FORMAT_COLUMN_MAJOR =0, OWL_MATRIX_FORMAT_OWL =OWL_MATRIX_FORMAT_COLUMN_MAJOR, OWL_MATRIX_FORMAT_ROW_MAJOR }
enum	OWLBuildSBTFlags {   OWL_SBT_HITGROUPS = 0x1, OWL_SBT_GEOMS = OWL_SBT_HITGROUPS, OWL_SBT_RAYGENS = 0x2, OWL_SBT_MISSPROGS = 0x4,   OWL_SBT_ALL = 0x7 }
enum	OWLDataType {   OWL_INVALID_TYPE = 0, OWL_BUFFER =10, OWL_BUFFER_SIZE, OWL_BUFFER_ID,   OWL_BUFFER_POINTER, OWL_BUFPTR =OWL_BUFFER_POINTER, OWL_GROUP =20, OWL_DEVICE =30,   OWL_TEXTURE =40, OWL_TEXTURE_2D =OWL_TEXTURE, _OWL_BEGIN_COPYABLE_TYPES = 1000, OWL_FLOAT =1000,   OWL_FLOAT2, OWL_FLOAT3, OWL_FLOAT4, OWL_INT =1100,   OWL_INT2, OWL_INT3, OWL_INT4, OWL_UINT =1200,   OWL_UINT2, OWL_UINT3, OWL_UINT4, OWL_LONG =1300,   OWL_LONG2, OWL_LONG3, OWL_LONG4, OWL_ULONG =1400,   OWL_ULONG2, OWL_ULONG3, OWL_ULONG4, OWL_DOUBLE =1500,   OWL_DOUBLE2, OWL_DOUBLE3, OWL_DOUBLE4, OWL_CHAR =1600,   OWL_CHAR2, OWL_CHAR3, OWL_CHAR4, OWL_UCHAR =1700,   OWL_UCHAR2, OWL_UCHAR3, OWL_UCHAR4, OWL_RAW_POINTER =OWL_ULONG,   OWL_AFFINE3F =1800, OWL_USER_TYPE_BEGIN =10000 }
enum	OWLGeomKind {   OWL_GEOMETRY_USER, OWL_GEOM_USER =OWL_GEOMETRY_USER, OWL_GEOMETRY_TRIANGLES, OWL_GEOM_TRIANGLES =OWL_GEOMETRY_TRIANGLES,   OWL_TRIANGLES =OWL_GEOMETRY_TRIANGLES, OWL_GEOMETRY_HAIR }
enum	OWLTexelFormat { OWL_TEXEL_FORMAT_RGBA8, OWL_TEXEL_FORMAT_RGBA32F, OWL_TEXEL_FORMAT_R8, OWL_TEXEL_FORMAT_R32F }
enum	OWLTextureFilterMode { OWL_TEXTURE_NEAREST, OWL_TEXTURE_LINEAR }
enum	OWLTextureAddressMode { OWL_TEXTURE_WRAP, OWL_TEXTURE_CLAMP, OWL_TEXTURE_BORDER, OWL_TEXTURE_MIRROR }

Functions
OWL_API void	owlBuildPrograms (OWLContext context)
OWL_API void	owlBuildPipeline (OWLContext context)
OWL_API void	owlBuildSBT (OWLContext context, OWLBuildSBTFlags flags OWL_IF_CPP(=OWL_SBT_ALL))
OWL_API int32_t	owlGetDeviceCount (OWLContext context)
OWL_API OWLContext	owlContextCreate (int32_t *requestedDeviceIDs OWL_IF_CPP(=nullptr), int numDevices OWL_IF_CPP(=0))
OWL_API void	owlEnableMotionBlur (OWLContext _context)
OWL_API void	owlContextSetRayTypeCount (OWLContext context, size_t numRayTypes)
OWL_API void	owlSetMaxInstancingDepth (OWLContext context, int32_t maxInstanceDepth)
OWL_API void	owlContextDestroy (OWLContext context)
OWL_API CUstream	owlContextGetStream (OWLContext context, int deviceID)
OWL_API OptixDeviceContext	owlContextGetOptixContext (OWLContext context, int deviceID)
OWL_API OWLModule	owlModuleCreate (OWLContext context, const char *ptxCode)
OWL_API OWLGeom	owlGeomCreate (OWLContext context, OWLGeomType type)
OWL_API OWLParams	owlParamsCreate (OWLContext context, size_t sizeOfVarStruct, OWLVarDecl *vars, int numVars)
OWL_API OWLRayGen	owlRayGenCreate (OWLContext context, OWLModule module, const char *programName, size_t sizeOfVarStruct, OWLVarDecl *vars, int numVars)
OWL_API OWLMissProg	owlMissProgCreate (OWLContext context, OWLModule module, const char *programName, size_t sizeOfVarStruct, OWLVarDecl *vars, int numVars)
OWL_API void	owlMissProgSet (OWLContext context, int rayType, OWLMissProg missProgToUse)
OWL_API OWLGroup	owlUserGeomGroupCreate (OWLContext context, size_t numGeometries, OWLGeom *arrayOfChildGeoms)
OWL_API OWLGroup	owlTrianglesGeomGroupCreate (OWLContext context, size_t numGeometries, OWLGeom *initValues)
OWL_API OWLGroup	owlInstanceGroupCreate (OWLContext context, size_t numInstances, const OWLGroup *initGroups OWL_IF_CPP(=nullptr), const uint32_t *initInstanceIDs OWL_IF_CPP(=nullptr), const float *initTransforms OWL_IF_CPP(=nullptr), OWLMatrixFormat matrixFormat OWL_IF_CPP(=OWL_MATRIX_FORMAT_OWL))
OWL_API void	owlGroupBuildAccel (OWLGroup group)
OWL_API void	owlGroupRefitAccel (OWLGroup group)
OWL_API OWLGeomType	owlGeomTypeCreate (OWLContext context, OWLGeomKind kind, size_t sizeOfVarStruct, OWLVarDecl *vars, int numVars)
OWL_API OWLTexture	owlTexture2DCreate (OWLContext context, OWLTexelFormat texelFormat, uint32_t size_x, uint32_t size_y, const void *texels, OWLTextureFilterMode filterMode OWL_IF_CPP(=OWL_TEXTURE_LINEAR), OWLTextureAddressMode addressMode OWL_IF_CPP(=OWL_TEXTURE_CLAMP), uint32_t linePitchInBytes OWL_IF_CPP(=0))
OWL_API CUtexObject	owlTextureGetObject (OWLTexture texture, int deviceID)
OWL_API void	owlTexture2DDestroy (OWLTexture texture)
OWL_API OWLBuffer	owlDeviceBufferCreate (OWLContext context, OWLDataType type, size_t count, const void *init)
OWL_API OWLBuffer	owlHostPinnedBufferCreate (OWLContext context, OWLDataType type, size_t count)
OWL_API OWLBuffer	owlManagedMemoryBufferCreate (OWLContext context, OWLDataType type, size_t count, const void *init)
OWL_API OWLBuffer	owlGraphicsBufferCreate (OWLContext context, OWLDataType type, size_t count, cudaGraphicsResource_t resource)
OWL_API void	owlGraphicsBufferMap (OWLBuffer buffer)
OWL_API void	owlGraphicsBufferUnmap (OWLBuffer buffer)
OWL_API const void *	owlBufferGetPointer (OWLBuffer buffer, int deviceID)
OWL_API OptixTraversableHandle	owlGroupGetTraversable (OWLGroup group, int deviceID)
OWL_API void	owlBufferResize (OWLBuffer buffer, size_t newItemCount)
OWL_API void	owlBufferDestroy (OWLBuffer buffer)
OWL_API void	owlBufferUpload (OWLBuffer buffer, const void *hostPtr)
OWL_API void	owlRayGenLaunch2D (OWLRayGen rayGen, int dims_x, int dims_y)
OWL_API void	owlLaunch2D (OWLRayGen rayGen, int dims_x, int dims_y, OWLParams params)
OWL_API void	owlAsyncLaunch2D (OWLRayGen rayGen, int dims_x, int dims_y, OWLParams params)
OWL_API CUstream	owlParamsGetCudaStream (OWLParams params, int deviceID)
OWL_API void	owlLaunchSync (OWLParams params)
OWL_API void	owlTrianglesSetVertices (OWLGeom triangles, OWLBuffer vertices, size_t count, size_t stride, size_t offset)
OWL_API void	owlTrianglesSetMotionVertices (OWLGeom triangles, size_t numKeys, OWLBuffer *vertexArrays, size_t count, size_t stride, size_t offset)
OWL_API void	owlTrianglesSetIndices (OWLGeom triangles, OWLBuffer indices, size_t count, size_t stride, size_t offset)
OWL_API void	owlInstanceGroupSetChild (OWLGroup group, int whichChild, OWLGroup child)
OWL_API void	owlInstanceGroupSetTransform (OWLGroup group, int whichChild, const float *floats, OWLMatrixFormat matrixFormat OWL_IF_CPP(=OWL_MATRIX_FORMAT_OWL))
OWL_API void	owlInstanceGroupSetTransforms (OWLGroup group, uint32_t timeStep, const float *floatsForThisStimeStep, OWLMatrixFormat matrixFormat OWL_IF_CPP(=OWL_MATRIX_FORMAT_OWL))
OWL_API void	owlInstanceGroupSetInstanceIDs (OWLGroup group, const uint32_t *instanceIDs)
OWL_API void	owlGeomTypeSetClosestHit (OWLGeomType type, int rayType, OWLModule module, const char *progName)
OWL_API void	owlGeomTypeSetAnyHit (OWLGeomType type, int rayType, OWLModule module, const char *progName)
OWL_API void	owlGeomTypeSetIntersectProg (OWLGeomType type, int rayType, OWLModule module, const char *progName)
OWL_API void	owlGeomTypeSetBoundsProg (OWLGeomType type, OWLModule module, const char *progName)
OWL_API void	owlGeomSetPrimCount (OWLGeom geom, size_t primCount)
OWL_API void	owlGeomRelease (OWLGeom geometry)
OWL_API void	owlVariableRelease (OWLVariable variable)
OWL_API void	owlModuleRelease (OWLModule module)
OWL_API void	owlBufferRelease (OWLBuffer buffer)
OWL_API void	owlRayGenRelease (OWLRayGen rayGen)
OWL_API void	owlGroupRelease (OWLGroup group)
OWL_API OWLVariable	owlGeomGetVariable (OWLGeom geom, const char *varName)
OWL_API OWLVariable	owlRayGenGetVariable (OWLRayGen geom, const char *varName)
OWL_API OWLVariable	owlMissProgGetVariable (OWLMissProg geom, const char *varName)
OWL_API OWLVariable	owlParamsGetVariable (OWLParams object, const char *varName)
OWL_API void	owlVariableSetGroup (OWLVariable variable, OWLGroup value)
OWL_API void	owlVariableSetTexture (OWLVariable variable, OWLTexture value)
OWL_API void	owlVariableSetBuffer (OWLVariable variable, OWLBuffer value)
OWL_API void	owlVariableSetRaw (OWLVariable variable, const void *valuePtr)
OWL_API void	owlVariableSetPointer (OWLVariable variable, const void *valuePtr)

Macro Definition Documentation

_OWL_SET_HELPER

#define _OWL_SET_HELPER	(		stype,
			abb
	)

Value:

  OWL_API void owlVariableSet1##abb(OWLVariable var,    \
                                    stype v);           \
  OWL_API void owlVariableSet2##abb(OWLVariable var,    \
                                    stype x,            \
                                    stype y);           \
  OWL_API void owlVariableSet3##abb(OWLVariable var,    \
                                    stype x,            \
                                    stype y,            \
                                    stype z);           \
  /*end of macro */

_OWL_SET_HELPERS

#define _OWL_SET_HELPERS

(

Type

)

_OWL_SET_HELPERS_C

#define _OWL_SET_HELPERS_C	(		OType,
			stype,
			abb
	)

_OWL_SET_HELPERS_CPP

#define _OWL_SET_HELPERS_CPP	(		OType,
			stype,
			abb
	)		/* ignore in C99 mode */

OWL_ALL_RAY_TYPES

#define OWL_ALL_RAY_TYPES   -1

OWL_API

#define OWL_API   /* bla */

OWL_DLL_EXPORT

#define OWL_DLL_EXPORT

OWL_DLL_IMPORT

#define OWL_DLL_IMPORT

OWL_IF_CPP

#define OWL_IF_CPP

(

a

)

/* drop it */

OWL_OFFSETOF

#define OWL_OFFSETOF	(		type,
			member
	)

Value:

  ((char *)(&((struct type *)0)-> member )      \
   -                                            \
   (char *)(((struct type *)0)))

OWL_USER_TYPE

#define OWL_USER_TYPE

(

userType

)

((OWLDataType)(OWL_USER_TYPE_BEGIN+sizeof(userType)))

Typedef Documentation

owl2d

typedef struct _OWL_double2 owl2d

owl2f

typedef struct _OWL_float2 owl2f

owl2i

typedef struct _OWL_int2 owl2i

owl2l

typedef struct _OWL_long2 owl2l

owl2ui

typedef struct _OWL_uint2 owl2ui

owl2ul

typedef struct _OWL_ulong2 owl2ul

owl3d

typedef struct _OWL_double3 owl3d

owl3f

typedef struct _OWL_float3 owl3f

owl3i

typedef struct _OWL_int3 owl3i

owl3l

typedef struct _OWL_long3 owl3l

owl3ui

typedef struct _OWL_uint3 owl3ui

owl3ul

typedef struct _OWL_ulong3 owl3ul

owl4d

typedef struct _OWL_double4 owl4d

owl4f

typedef struct _OWL_float4 owl4f

owl4i

typedef struct _OWL_int4 owl4i

owl4l

typedef struct _OWL_long4 owl4l

owl4ui

typedef struct _OWL_uint4 owl4ui

owl4ul

typedef struct _OWL_ulong4 owl4ul

owl4x3f

typedef struct _OWL_affine3f owl4x3f

OWL_double

typedef double OWL_double

OWL_float

typedef float OWL_float

OWL_int

typedef int32_t OWL_int

OWL_long

typedef int64_t OWL_long

OWL_uint

typedef uint32_t OWL_uint

OWL_ulong

typedef uint64_t OWL_ulong

OWLBuffer

typedef struct _OWLBuffer* OWLBuffer

OWLContext

typedef struct _OWLContext* OWLContext

OWLDeviceBuffer2D

typedef struct _OWLDeviceBuffer2D OWLDeviceBuffer2D

OWLDeviceTraversable

typedef OptixTraversableHandle OWLDeviceTraversable

OWLGeom

typedef struct _OWLGeom* OWLGeom

OWLGeomType

typedef struct _OWLGeomType* OWLGeomType

OWLGlobals

typedef struct _OWLLaunchParams * OWLGlobals

OWLGroup

typedef struct _OWLGroup* OWLGroup

OWLLaunchParams

typedef struct _OWLLaunchParams* OWLLaunchParams

launch params (or "globals") are variables that can be put into device constant memory, accessible through a CUDA "__constant__ <Type> optixLaunchParams;" variable on the device side. Launch params capture the layout of this struct, and the value of its members, on the host side, then properly fill it in before executing a launch. OptiX calls those "launch parameters" because they are similar to how parameters to a CUDA kernel are internally treated; we also call them "globals" because they are globally accessible to all programs within a given launch

OWLMissProg

typedef struct _OWLMissProg* OWLMissProg

OWLModule

typedef struct _OWLModule* OWLModule

OWLParams

typedef struct _OWLLaunchParams * OWLParams

OWLRayGen

typedef struct _OWLRayGen* OWLRayGen

OWLTexture

typedef struct _OWLTexture* OWLTexture

OWLVarDecl

typedef struct _OWLVarDecl OWLVarDecl

OWLVariable

typedef struct _OWLVariable* OWLVariable

Enumeration Type Documentation

OWLBuildSBTFlags

enum OWLBuildSBTFlags

Enumerator
OWL_SBT_HITGROUPS
OWL_SBT_GEOMS
OWL_SBT_RAYGENS
OWL_SBT_MISSPROGS
OWL_SBT_ALL

OWLDataType

enum OWLDataType

Enumerator
OWL_INVALID_TYPE
OWL_BUFFER
OWL_BUFFER_SIZE
OWL_BUFFER_ID
OWL_BUFFER_POINTER
OWL_BUFPTR
OWL_GROUP
OWL_DEVICE	implicit variable of type integer that specifies the index of the given device. this variable type is implicit in the sense that it only gets declared on the host, and gets set automatically during SBT creation
OWL_TEXTURE	texture(s)
OWL_TEXTURE_2D
_OWL_BEGIN_COPYABLE_TYPES
OWL_FLOAT
OWL_FLOAT2
OWL_FLOAT3
OWL_FLOAT4
OWL_INT
OWL_INT2
OWL_INT3
OWL_INT4
OWL_UINT
OWL_UINT2
OWL_UINT3
OWL_UINT4
OWL_LONG
OWL_LONG2
OWL_LONG3
OWL_LONG4
OWL_ULONG
OWL_ULONG2
OWL_ULONG3
OWL_ULONG4
OWL_DOUBLE
OWL_DOUBLE2
OWL_DOUBLE3
OWL_DOUBLE4
OWL_CHAR
OWL_CHAR2
OWL_CHAR3
OWL_CHAR4
OWL_UCHAR	unsigend 8-bit integer
OWL_UCHAR2
OWL_UCHAR3
OWL_UCHAR4
OWL_RAW_POINTER	just another name for a 64-bit data type - unlike OWL_BUFFER_POINTER's (which gets translated from OWLBuffer's to actual device-side poiners) these OWL_RAW_POINTER types get copied binary without any translation. This is useful for owl-cuda interaction (where the user already has device pointers), but should not be used for logical buffers
OWL_AFFINE3F
OWL_USER_TYPE_BEGIN	at least for now, use that for buffers with user-defined types: type then is "OWL_USER_TYPE_BEGIN+sizeof(elementtype). Note that since we always add the user type's size to this value this MUST be the last entry in the enum

OWLGeomKind

enum OWLGeomKind

Enumerator
OWL_GEOMETRY_USER
OWL_GEOM_USER
OWL_GEOMETRY_TRIANGLES
OWL_GEOM_TRIANGLES
OWL_TRIANGLES
OWL_GEOMETRY_HAIR

OWLMatrixFormat

enum OWLMatrixFormat

enum that specifies the different possible memory layouts for passing transformation matrices

Enumerator
OWL_MATRIX_FORMAT_COLUMN_MAJOR	4x3-float column-major matrix format, where a matrix is specified through four vec3fs, the first three being the basis vectors of the linear transform, and the fourth one the translation part. This is exactly the same layout as used in owl::common::affine3f (owl/common/math/AffineSpae.h)
OWL_MATRIX_FORMAT_OWL	just another name for OWL_MATRIX_FORMAT_4X3_COLUMN_MAJOR that is easier to type - the "_OWL" indicates that this is the default format in the owl::common namespace
OWL_MATRIX_FORMAT_ROW_MAJOR	3x4-float row-major layout as preferred by optix; in this case it doesn't matter if it's a 4x3 or 4x4 matrix, since the last row in a 4x4 row major matrix can simply be ignored

OWLTexelFormat

enum OWLTexelFormat

supported formats for texels in textures

Enumerator
OWL_TEXEL_FORMAT_RGBA8
OWL_TEXEL_FORMAT_RGBA32F
OWL_TEXEL_FORMAT_R8
OWL_TEXEL_FORMAT_R32F

OWLTextureAddressMode

enum OWLTextureAddressMode

currently supported texture filter modes

Enumerator
OWL_TEXTURE_WRAP
OWL_TEXTURE_CLAMP
OWL_TEXTURE_BORDER
OWL_TEXTURE_MIRROR

OWLTextureFilterMode

enum OWLTextureFilterMode

currently supported texture filter modes

Enumerator
OWL_TEXTURE_NEAREST
OWL_TEXTURE_LINEAR

Function Documentation

owlAsyncLaunch2D()

OWL_API void owlAsyncLaunch2D	(	OWLRayGen	rayGen,
		int	dims_x,
		int	dims_y,
		OWLParams	params
	)

perform a raygen launch with lauch parameters, in a A*synchronous way; it, this will only launch, but *NOT wait for completion (see owlLaunchSync)

owlBufferDestroy()

OWL_API void owlBufferDestroy

(

OWLBuffer

buffer

)

destroy the given buffer; this will both release the app's refcount on the given buffer handle, and the buffer itself; ie, even if some objects still hold variables that refer to the old handle the buffer itself will be freed

owlBufferGetPointer()

OWL_API const void* owlBufferGetPointer	(	OWLBuffer	buffer,
		int	deviceID
	)

returns the device pointer of the given pointer for the given device ID. For host-pinned or managed memory buffers (where the buffer is shared across all devices) this pointer should be the same across all devices (and even be accessible on the host); for device buffers each device may see this buffer under a different address, and that address is not valid on the host. Note this function is paricuarly useful for CUDA-interop; allowing to cudaMemcpy to/from an owl buffer directly from CUDA code

owlBufferRelease()

OWL_API void owlBufferRelease

(

OWLBuffer

buffer

)

owlBufferResize()

OWL_API void owlBufferResize	(	OWLBuffer	buffer,
		size_t	newItemCount
	)

owlBufferUpload()

OWL_API void owlBufferUpload	(	OWLBuffer	buffer,
		const void *	hostPtr
	)

owlBuildPipeline()

OWL_API void owlBuildPipeline

(

OWLContext

context

)

owlBuildPrograms()

OWL_API void owlBuildPrograms

(

OWLContext

context

)

owlBuildSBT()

OWL_API void owlBuildSBT	(	OWLContext	context,
		OWLBuildSBTFlags flags	OWL_IF_CPP=OWL_SBT_ALL
	)

owlContextCreate()

OWL_API OWLContext owlContextCreate	(	int32_t *requestedDeviceIDs	OWL_IF_CPP=nullptr,
		int numDevices	OWL_IF_CPP=0
	)

creates a new device context with the gives list of devices.

If requested device IDs list if null it implicitly refers to the list "0,1,2,...."; if numDevices <= 0 it automatically refers to "all devices you can find". Examples:

• owlContextCreate(nullptr,1) creates one device on the first GPU
• owlContextCreate(nullptr,0) creates a context across all GPUs in the system
• int gpu=2;owlContextCreate(&gpu,1) will create a context on GPU #2 (where 2 refers to the CUDA device ordinal; from that point on, from owl's standpoint (eg, during owlBufferGetPointer() this GPU will from that point on be known as device #0

owlContextDestroy()

OWL_API void owlContextDestroy

(

OWLContext

context

)

owlContextGetOptixContext()

OWL_API OptixDeviceContext owlContextGetOptixContext	(	OWLContext	context,
		int	deviceID
	)

owlContextGetStream()

OWL_API CUstream owlContextGetStream	(	OWLContext	context,
		int	deviceID
	)

owlContextSetRayTypeCount()

OWL_API void owlContextSetRayTypeCount	(	OWLContext	context,
		size_t	numRayTypes
	)

set number of ray types to be used in this context; this should be done before any programs, pipelines, geometries, etc get created

owlDeviceBufferCreate()

OWL_API OWLBuffer owlDeviceBufferCreate	(	OWLContext	context,
		OWLDataType	type,
		size_t	count,
		const void *	init
	)

creates a device buffer where every device has its own local copy of the given buffer

owlEnableMotionBlur()

OWL_API void owlEnableMotionBlur

(

OWLContext

_context

)

enable motion blur for this context. this has to be called before creating any geometries, groups, etc, and before the pipeline gets compiled. Ie, it shold be called right after context creation

owlGeomCreate()

OWL_API OWLGeom owlGeomCreate	(	OWLContext	context,
		OWLGeomType	type
	)

owlGeomGetVariable()

OWL_API OWLVariable owlGeomGetVariable	(	OWLGeom	geom,
		const char *	varName
	)

owlGeomRelease()

OWL_API void owlGeomRelease

(

OWLGeom

geometry

)

owlGeomSetPrimCount()

OWL_API void owlGeomSetPrimCount	(	OWLGeom	geom,
		size_t	primCount
	)

set the primitive count for the given uesr geometry. this has to be set before the group(s) that this geom is used in get built

owlGeomTypeCreate()

OWL_API OWLGeomType owlGeomTypeCreate	(	OWLContext	context,
		OWLGeomKind	kind,
		size_t	sizeOfVarStruct,
		OWLVarDecl *	vars,
		int	numVars
	)

owlGeomTypeSetAnyHit()

OWL_API void owlGeomTypeSetAnyHit	(	OWLGeomType	type,
		int	rayType,
		OWLModule	module,
		const char *	progName
	)

owlGeomTypeSetBoundsProg()

OWL_API void owlGeomTypeSetBoundsProg	(	OWLGeomType	type,
		OWLModule	module,
		const char *	progName
	)

owlGeomTypeSetClosestHit()

OWL_API void owlGeomTypeSetClosestHit	(	OWLGeomType	type,
		int	rayType,
		OWLModule	module,
		const char *	progName
	)

owlGeomTypeSetIntersectProg()

OWL_API void owlGeomTypeSetIntersectProg	(	OWLGeomType	type,
		int	rayType,
		OWLModule	module,
		const char *	progName
	)

owlGetDeviceCount()

OWL_API int32_t owlGetDeviceCount

(

OWLContext

context

)

returns number of devices available in the given context

owlGraphicsBufferCreate()

OWL_API OWLBuffer owlGraphicsBufferCreate	(	OWLContext	context,
		OWLDataType	type,
		size_t	count,
		cudaGraphicsResource_t	resource
	)

creates a buffer wrapping a CUDA graphics resource; the resource must be created and registered by the user

owlGraphicsBufferMap()

OWL_API void owlGraphicsBufferMap

(

OWLBuffer

buffer

)

owlGraphicsBufferUnmap()

OWL_API void owlGraphicsBufferUnmap

(

OWLBuffer

buffer

)

owlGroupBuildAccel()

OWL_API void owlGroupBuildAccel

(

OWLGroup

group

)

owlGroupGetTraversable()

OWL_API OptixTraversableHandle owlGroupGetTraversable	(	OWLGroup	group,
		int	deviceID
	)

owlGroupRefitAccel()

OWL_API void owlGroupRefitAccel

(

OWLGroup

group

)

owlGroupRelease()

OWL_API void owlGroupRelease

(

OWLGroup

group

)

owlHostPinnedBufferCreate()

OWL_API OWLBuffer owlHostPinnedBufferCreate	(	OWLContext	context,
		OWLDataType	type,
		size_t	count
	)

creates a buffer that uses CUDA host pinned memory; that memory is pinned on the host and accessive to all devices in the deviec group

owlInstanceGroupCreate()

OWL_API OWLGroup owlInstanceGroupCreate	(	OWLContext	context,
		size_t	numInstances,
		const OWLGroup *initGroups	OWL_IF_CPP=nullptr,
		const uint32_t *initInstanceIDs	OWL_IF_CPP=nullptr,
		const float *initTransforms	OWL_IF_CPP=nullptr,
		OWLMatrixFormat matrixFormat	OWL_IF_CPP=OWL_MATRIX_FORMAT_OWL
	)

create a new instance group with given number of instances. The child groups and their instance IDs and/or transforms can either be specified "in bulk" as part of this call, or can be set lateron with inviidaul calls to

See also

owlInstanceGroupSetChild and

owlInstanceGroupSetTransform. Note however, that in the case of having millions of instances in a group it will be much more efficient to set them in bulk open creation, than in millions of inidiviual API calls.

Either or all of initGroups, initTranforms, or initInstanceIDs may be null, in which case the values used for the 'th child will be a null group, a unit transform, and 'i', respectively.

Parameters

numInstances	number of instances in this group
OWL_IF_CPP	the initial list of owl groups to use by the instances in this group; must be either null, or an array of the size 'numInstnaces', the i'th instnace in this gorup will be an instance o the i'th element in this list
OWL_IF_CPP	instance IDs to use for the instance in this group; must be eithe rnull, or an array of size numInstnaces. If null, the i'th child of this instance group will use instanceID=i, otherwise, it will use the user-provided instnace ID from this list. Specifying an instanceID will affect what value 'optixGetInstanceID' will return in a CH program that refers to the given instance
OWL_IF_CPP	initial list of transforms that this instance group will use; must be either null, or an array of size numInstnaces, of the format specified

owlInstanceGroupSetChild()

OWL_API void owlInstanceGroupSetChild	(	OWLGroup	group,
		int	whichChild,
		OWLGroup	child
	)

owlInstanceGroupSetInstanceIDs()

OWL_API void owlInstanceGroupSetInstanceIDs	(	OWLGroup	group,
		const uint32_t *	instanceIDs
	)

sets the list of IDs to use for the child instnaces. By default the instance ID of child #i is simply i, but optix allows to specify a user-defined instnace ID for each instance, which with owl can be done through this array. Array size must match number of instances in the specified group

owlInstanceGroupSetTransform()

OWL_API void owlInstanceGroupSetTransform	(	OWLGroup	group,
		int	whichChild,
		const float *	floats,
		OWLMatrixFormat matrixFormat	OWL_IF_CPP=OWL_MATRIX_FORMAT_OWL
	)

sets the transformatoin matrix to be applied to the childID'th child of the given instance group

owlInstanceGroupSetTransforms()

OWL_API void owlInstanceGroupSetTransforms	(	OWLGroup	group,
		uint32_t	timeStep,
		const float *	floatsForThisStimeStep,
		OWLMatrixFormat matrixFormat	OWL_IF_CPP=OWL_MATRIX_FORMAT_OWL
	)

this function allows to set up to N different arrays of trnsforms for motion blur; the first such array is used as transforms for t=0, the last one for t=1.

Parameters

timeStep

whether to set for t=0 or t=1 - currently supporting only 0 or 1

owlLaunch2D()

OWL_API void owlLaunch2D	(	OWLRayGen	rayGen,
		int	dims_x,
		int	dims_y,
		OWLParams	params
	)

perform a raygen launch with lauch parameters, in a synchronous way; it, by the time this function returns the launch is completed

owlLaunchSync()

OWL_API void owlLaunchSync

(

OWLParams

params

)

wait for the async launch to finish

owlManagedMemoryBufferCreate()

OWL_API OWLBuffer owlManagedMemoryBufferCreate	(	OWLContext	context,
		OWLDataType	type,
		size_t	count,
		const void *	init
	)

creates a buffer that uses CUDA managed memory; that memory is managed by CUDA (see CUDAs documentatoin on managed memory) and accessive to all devices in the deviec group

owlMissProgCreate()

OWL_API OWLMissProg owlMissProgCreate	(	OWLContext	context,
		OWLModule	module,
		const char *	programName,
		size_t	sizeOfVarStruct,
		OWLVarDecl *	vars,
		int	numVars
	)

creates a miss program with given function name (in given module) and given variables. Note due to backwards compatibility this will also automatically set, by default, the first such created program as miss program for ray type number 0, the second one for ray type number 1, etc. If another order is desired, you can use

See also

owlMissProgSet to explicitly assign miss programs to specific ray types

owlMissProgGetVariable()

OWL_API OWLVariable owlMissProgGetVariable	(	OWLMissProg	geom,
		const char *	varName
	)

owlMissProgSet()

OWL_API void owlMissProgSet	(	OWLContext	context,
		int	rayType,
		OWLMissProg	missProgToUse
	)

sets the given miss program for the given ray type

owlModuleCreate()

OWL_API OWLModule owlModuleCreate	(	OWLContext	context,
		const char *	ptxCode
	)

owlModuleRelease()

OWL_API void owlModuleRelease

(

OWLModule

module

)

owlParamsCreate()

OWL_API OWLParams owlParamsCreate	(	OWLContext	context,
		size_t	sizeOfVarStruct,
		OWLVarDecl *	vars,
		int	numVars
	)

owlParamsGetCudaStream()

OWL_API CUstream owlParamsGetCudaStream	(	OWLParams	params,
		int	deviceID
	)

owlParamsGetVariable()

OWL_API OWLVariable owlParamsGetVariable	(	OWLParams	object,
		const char *	varName
	)

owlRayGenCreate()

OWL_API OWLRayGen owlRayGenCreate	(	OWLContext	context,
		OWLModule	module,
		const char *	programName,
		size_t	sizeOfVarStruct,
		OWLVarDecl *	vars,
		int	numVars
	)

owlRayGenGetVariable()

OWL_API OWLVariable owlRayGenGetVariable	(	OWLRayGen	geom,
		const char *	varName
	)

owlRayGenLaunch2D()

OWL_API void owlRayGenLaunch2D	(	OWLRayGen	rayGen,
		int	dims_x,
		int	dims_y
	)

executes an optix lauch of given size, with given launch program. Note this is asynchronous, and may not be completed by the time this function returns.

owlRayGenRelease()

OWL_API void owlRayGenRelease

(

OWLRayGen

rayGen

)

owlSetMaxInstancingDepth()

OWL_API void owlSetMaxInstancingDepth	(	OWLContext	context,
		int32_t	maxInstanceDepth
	)

sets maximum instancing depth for the given context:

'0' means 'no instancing allowed, only bottom-level accels; Note this mode isn't actually allowed in OWL right now, as the most convenient way of realizing it is actually slower than simply putting a single "dummy" instance (with just this one child, and a identify transform) over each blas.

'1' means 'at most one layer of instances' (ie, a two-level scene), where the 'root' world rays are traced against can be an instance group, but every child in that inscne group is a geometry group.

'N>1" means "up to N layers of instances are allowed.

The default instancing depth is 1 (ie, a two-level scene), since this allows for most use cases of instancing and is still hardware-accelerated. Using a node graph with instancing deeper than the configured value will result in wrong results; but be aware that using any value > 1 here will come with a cost. It is recommended to, if at all possible, leave this value to one and convert the input scene to a two-level scene layout (ie, with only one level of instances)

owlTexture2DCreate()

OWL_API OWLTexture owlTexture2DCreate	(	OWLContext	context,
		OWLTexelFormat	texelFormat,
		uint32_t	size_x,
		uint32_t	size_y,
		const void *	texels,
		OWLTextureFilterMode filterMode	OWL_IF_CPP=OWL_TEXTURE_LINEAR,
		OWLTextureAddressMode addressMode	OWL_IF_CPP=OWL_TEXTURE_CLAMP,
		uint32_t linePitchInBytes	OWL_IF_CPP=0
	)

create new texture of given format and dimensions - for now, we only do "wrap" textures, and eithe rbilinear or nearest filter; once we allow for doing things like texture borders we'll have to change this api

Parameters

size_x	number of texels in x dimension
size_y	number of texels in y dimension
OWL_IF_CPP	number of bytes between one line of texels and the next; '0' means 'size_x * sizeof(texel)'

owlTexture2DDestroy()

OWL_API void owlTexture2DDestroy

(

OWLTexture

texture

)

destroy the given texture; after this call any accesses to the given texture are invalid

owlTextureGetObject()

OWL_API CUtexObject owlTextureGetObject	(	OWLTexture	texture,
		int	deviceID
	)

returns the device handle of the given texture for the given device ID. Useful for custom texture object arrays.

owlTrianglesGeomGroupCreate()

OWL_API OWLGroup owlTrianglesGeomGroupCreate	(	OWLContext	context,
		size_t	numGeometries,
		OWLGeom *	initValues
	)

create a new group (which handles the acceleration strucure) for triangle geometries.

Parameters

numGeometries	Number of geometries in this group, must be non-zero.
arrayOfChildGeoms	A array of 'numGeometries' child geometries. Every geom in this array must be a valid owl geometry created with owlGeomCreate, and must be of a OWL_GEOM_TRIANGLES type.

owlTrianglesSetIndices()

OWL_API void owlTrianglesSetIndices	(	OWLGeom	triangles,
		OWLBuffer	indices,
		size_t	count,
		size_t	stride,
		size_t	offset
	)

owlTrianglesSetMotionVertices()

OWL_API void owlTrianglesSetMotionVertices	(	OWLGeom	triangles,
		size_t	numKeys,
		OWLBuffer *	vertexArrays,
		size_t	count,
		size_t	stride,
		size_t	offset
	)

Parameters

numKeys

number of vertex arrays passed here, the first of those is for t=0, thelast for t=1, everything is linearly interpolated in-between

owlTrianglesSetVertices()

OWL_API void owlTrianglesSetVertices	(	OWLGeom	triangles,
		OWLBuffer	vertices,
		size_t	count,
		size_t	stride,
		size_t	offset
	)

owlUserGeomGroupCreate()

OWL_API OWLGroup owlUserGeomGroupCreate	(	OWLContext	context,
		size_t	numGeometries,
		OWLGeom *	arrayOfChildGeoms
	)

create a new group (which handles the acceleration strucure) for triangle geometries.

Parameters

numGeometries	Number of geometries in this group, must be non-zero.
arrayOfChildGeoms	A array of 'numGeomteries' child geometries. Every geom in this array must be a valid owl geometry created with owlGeomCreate, and must be of a OWL_GEOM_USER type.

owlVariableRelease()

OWL_API void owlVariableRelease

(

OWLVariable

variable

)

owlVariableSetBuffer()

OWL_API void owlVariableSetBuffer	(	OWLVariable	variable,
		OWLBuffer	value
	)

owlVariableSetGroup()

OWL_API void owlVariableSetGroup	(	OWLVariable	variable,
		OWLGroup	value
	)

owlVariableSetPointer()

OWL_API void owlVariableSetPointer	(	OWLVariable	variable,
		const void *	valuePtr
	)

owlVariableSetRaw()

OWL_API void owlVariableSetRaw	(	OWLVariable	variable,
		const void *	valuePtr
	)

owlVariableSetTexture()

OWL_API void owlVariableSetTexture	(	OWLVariable	variable,
		OWLTexture	value
	)