253 lines
12 KiB
C++
253 lines
12 KiB
C++
// Copyright 2009-2021 Intel Corporation
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
#pragma once
|
|
|
|
#include "rtcore_device.h"
|
|
|
|
RTC_NAMESPACE_BEGIN
|
|
|
|
/* Forward declarations for ray structures */
|
|
struct RTCRayHit;
|
|
struct RTCRayHit4;
|
|
struct RTCRayHit8;
|
|
struct RTCRayHit16;
|
|
|
|
/* Scene flags */
|
|
enum RTCSceneFlags
|
|
{
|
|
RTC_SCENE_FLAG_NONE = 0,
|
|
RTC_SCENE_FLAG_DYNAMIC = (1 << 0),
|
|
RTC_SCENE_FLAG_COMPACT = (1 << 1),
|
|
RTC_SCENE_FLAG_ROBUST = (1 << 2),
|
|
RTC_SCENE_FLAG_FILTER_FUNCTION_IN_ARGUMENTS = (1 << 3)
|
|
};
|
|
|
|
/* Additional arguments for rtcIntersect1/4/8/16 calls */
|
|
struct RTCIntersectArguments
|
|
{
|
|
enum RTCRayQueryFlags flags; // intersection flags
|
|
enum RTCFeatureFlags feature_mask; // selectively enable features for traversal
|
|
struct RTCRayQueryContext* context; // optional pointer to ray query context
|
|
RTCFilterFunctionN filter; // filter function to execute
|
|
RTCIntersectFunctionN intersect; // user geometry intersection callback to execute
|
|
#if RTC_MIN_WIDTH
|
|
float minWidthDistanceFactor; // curve radius is set to this factor times distance to ray origin
|
|
#endif
|
|
};
|
|
|
|
/* Initializes intersection arguments. */
|
|
RTC_FORCEINLINE void rtcInitIntersectArguments(struct RTCIntersectArguments* args)
|
|
{
|
|
args->flags = RTC_RAY_QUERY_FLAG_INCOHERENT;
|
|
args->feature_mask = RTC_FEATURE_FLAG_ALL;
|
|
args->context = NULL;
|
|
args->filter = NULL;
|
|
args->intersect = NULL;
|
|
|
|
#if RTC_MIN_WIDTH
|
|
args->minWidthDistanceFactor = 0.0f;
|
|
#endif
|
|
}
|
|
|
|
/* Additional arguments for rtcOccluded1/4/8/16 calls */
|
|
struct RTCOccludedArguments
|
|
{
|
|
enum RTCRayQueryFlags flags; // intersection flags
|
|
enum RTCFeatureFlags feature_mask; // selectively enable features for traversal
|
|
struct RTCRayQueryContext* context; // optional pointer to ray query context
|
|
RTCFilterFunctionN filter; // filter function to execute
|
|
RTCOccludedFunctionN occluded; // user geometry occlusion callback to execute
|
|
|
|
#if RTC_MIN_WIDTH
|
|
float minWidthDistanceFactor; // curve radius is set to this factor times distance to ray origin
|
|
#endif
|
|
};
|
|
|
|
/* Initializes an intersection arguments. */
|
|
RTC_FORCEINLINE void rtcInitOccludedArguments(struct RTCOccludedArguments* args)
|
|
{
|
|
args->flags = RTC_RAY_QUERY_FLAG_INCOHERENT;
|
|
args->feature_mask = RTC_FEATURE_FLAG_ALL;
|
|
args->context = NULL;
|
|
args->filter = NULL;
|
|
args->occluded = NULL;
|
|
|
|
#if RTC_MIN_WIDTH
|
|
args->minWidthDistanceFactor = 0.0f;
|
|
#endif
|
|
}
|
|
|
|
/* Creates a new scene. */
|
|
RTC_API RTCScene rtcNewScene(RTCDevice device);
|
|
|
|
/* Returns the device the scene got created in. The reference count of
|
|
* the device is incremented by this function. */
|
|
RTC_API RTCDevice rtcGetSceneDevice(RTCScene hscene);
|
|
|
|
/* Retains the scene (increments the reference count). */
|
|
RTC_API void rtcRetainScene(RTCScene scene);
|
|
|
|
/* Releases the scene (decrements the reference count). */
|
|
RTC_API void rtcReleaseScene(RTCScene scene);
|
|
|
|
|
|
/* Attaches the geometry to a scene. */
|
|
RTC_API unsigned int rtcAttachGeometry(RTCScene scene, RTCGeometry geometry);
|
|
|
|
/* Attaches the geometry to a scene using the specified geometry ID. */
|
|
RTC_API void rtcAttachGeometryByID(RTCScene scene, RTCGeometry geometry, unsigned int geomID);
|
|
|
|
/* Detaches the geometry from the scene. */
|
|
RTC_API void rtcDetachGeometry(RTCScene scene, unsigned int geomID);
|
|
|
|
/* Gets a geometry handle from the scene. This function is not thread safe and should get used during rendering. */
|
|
RTC_API RTCGeometry rtcGetGeometry(RTCScene scene, unsigned int geomID);
|
|
|
|
/* Gets a geometry handle from the scene. This function is thread safe and should NOT get used during rendering. */
|
|
RTC_API RTCGeometry rtcGetGeometryThreadSafe(RTCScene scene, unsigned int geomID);
|
|
|
|
/* Gets the user-defined data pointer of the geometry. This function is not thread safe and should get used during rendering. */
|
|
RTC_SYCL_API void* rtcGetGeometryUserDataFromScene(RTCScene scene, unsigned int geomID);
|
|
|
|
/* Returns the interpolated transformation of an instance for the specified time. */
|
|
RTC_SYCL_API void rtcGetGeometryTransformFromScene(RTCScene scene, unsigned int geomID, float time, enum RTCFormat format, void* xfm);
|
|
|
|
|
|
/* Commits the scene. */
|
|
RTC_API void rtcCommitScene(RTCScene scene);
|
|
|
|
/* Commits the scene from multiple threads. */
|
|
RTC_API void rtcJoinCommitScene(RTCScene scene);
|
|
|
|
|
|
/* Progress monitor callback function */
|
|
typedef bool (*RTCProgressMonitorFunction)(void* ptr, double n);
|
|
|
|
/* Sets the progress monitor callback function of the scene. */
|
|
RTC_API void rtcSetSceneProgressMonitorFunction(RTCScene scene, RTCProgressMonitorFunction progress, void* ptr);
|
|
|
|
/* Sets the build quality of the scene. */
|
|
RTC_API void rtcSetSceneBuildQuality(RTCScene scene, enum RTCBuildQuality quality);
|
|
|
|
/* Sets the scene flags. */
|
|
RTC_API void rtcSetSceneFlags(RTCScene scene, enum RTCSceneFlags flags);
|
|
|
|
/* Returns the scene flags. */
|
|
RTC_API enum RTCSceneFlags rtcGetSceneFlags(RTCScene scene);
|
|
|
|
/* Returns the axis-aligned bounds of the scene. */
|
|
RTC_API void rtcGetSceneBounds(RTCScene scene, struct RTCBounds* bounds_o);
|
|
|
|
/* Returns the linear axis-aligned bounds of the scene. */
|
|
RTC_API void rtcGetSceneLinearBounds(RTCScene scene, struct RTCLinearBounds* bounds_o);
|
|
|
|
|
|
/* Perform a closest point query of the scene. */
|
|
RTC_API bool rtcPointQuery(RTCScene scene, struct RTCPointQuery* query, struct RTCPointQueryContext* context, RTCPointQueryFunction queryFunc, void* userPtr);
|
|
|
|
/* Perform a closest point query with a packet of 4 points with the scene. */
|
|
RTC_API bool rtcPointQuery4(const int* valid, RTCScene scene, struct RTCPointQuery4* query, struct RTCPointQueryContext* context, RTCPointQueryFunction queryFunc, void** userPtr);
|
|
|
|
/* Perform a closest point query with a packet of 4 points with the scene. */
|
|
RTC_API bool rtcPointQuery8(const int* valid, RTCScene scene, struct RTCPointQuery8* query, struct RTCPointQueryContext* context, RTCPointQueryFunction queryFunc, void** userPtr);
|
|
|
|
/* Perform a closest point query with a packet of 4 points with the scene. */
|
|
RTC_API bool rtcPointQuery16(const int* valid, RTCScene scene, struct RTCPointQuery16* query, struct RTCPointQueryContext* context, RTCPointQueryFunction queryFunc, void** userPtr);
|
|
|
|
|
|
/* Intersects a single ray with the scene. */
|
|
RTC_SYCL_API void rtcIntersect1(RTCScene scene, struct RTCRayHit* rayhit, struct RTCIntersectArguments* args RTC_OPTIONAL_ARGUMENT);
|
|
|
|
/* Intersects a packet of 4 rays with the scene. */
|
|
RTC_API void rtcIntersect4(const int* valid, RTCScene scene, struct RTCRayHit4* rayhit, struct RTCIntersectArguments* args RTC_OPTIONAL_ARGUMENT);
|
|
|
|
/* Intersects a packet of 8 rays with the scene. */
|
|
RTC_API void rtcIntersect8(const int* valid, RTCScene scene, struct RTCRayHit8* rayhit, struct RTCIntersectArguments* args RTC_OPTIONAL_ARGUMENT);
|
|
|
|
/* Intersects a packet of 16 rays with the scene. */
|
|
RTC_API void rtcIntersect16(const int* valid, RTCScene scene, struct RTCRayHit16* rayhit, struct RTCIntersectArguments* args RTC_OPTIONAL_ARGUMENT);
|
|
|
|
|
|
/* Forwards ray inside user geometry callback. */
|
|
RTC_SYCL_API void rtcForwardIntersect1(const struct RTCIntersectFunctionNArguments* args, RTCScene scene, struct RTCRay* ray, unsigned int instID);
|
|
|
|
/* Forwards ray inside user geometry callback. Extended to handle instance arrays using instPrimID parameter. */
|
|
RTC_SYCL_API void rtcForwardIntersect1Ex(const struct RTCIntersectFunctionNArguments* args, RTCScene scene, struct RTCRay* ray, unsigned int instID, unsigned int instPrimID);
|
|
|
|
/* Forwards ray packet of size 4 inside user geometry callback. */
|
|
RTC_API void rtcForwardIntersect4(const int* valid, const struct RTCIntersectFunctionNArguments* args, RTCScene scene, struct RTCRay4* ray, unsigned int instID);
|
|
|
|
/* Forwards ray packet of size 4 inside user geometry callback. Extended to handle instance arrays using instPrimID parameter. */
|
|
RTC_API void rtcForwardIntersect4Ex(const int* valid, const struct RTCIntersectFunctionNArguments* args, RTCScene scene, struct RTCRay4* ray, unsigned int instID, unsigned int primInstID);
|
|
|
|
/* Forwards ray packet of size 8 inside user geometry callback. */
|
|
RTC_API void rtcForwardIntersect8(const int* valid, const struct RTCIntersectFunctionNArguments* args, RTCScene scene, struct RTCRay8* ray, unsigned int instID);
|
|
|
|
/* Forwards ray packet of size 4 inside user geometry callback. Extended to handle instance arrays using instPrimID parameter. */
|
|
RTC_API void rtcForwardIntersect8Ex(const int* valid, const struct RTCIntersectFunctionNArguments* args, RTCScene scene, struct RTCRay8* ray, unsigned int instID, unsigned int primInstID);
|
|
|
|
/* Forwards ray packet of size 16 inside user geometry callback. */
|
|
RTC_API void rtcForwardIntersect16(const int* valid, const struct RTCIntersectFunctionNArguments* args, RTCScene scene, struct RTCRay16* ray, unsigned int instID);
|
|
|
|
/* Forwards ray packet of size 4 inside user geometry callback. Extended to handle instance arrays using instPrimID parameter. */
|
|
RTC_API void rtcForwardIntersect16Ex(const int* valid, const struct RTCIntersectFunctionNArguments* args, RTCScene scene, struct RTCRay16* ray, unsigned int instID, unsigned int primInstID);
|
|
|
|
|
|
/* Tests a single ray for occlusion with the scene. */
|
|
RTC_SYCL_API void rtcOccluded1(RTCScene scene, struct RTCRay* ray, struct RTCOccludedArguments* args RTC_OPTIONAL_ARGUMENT);
|
|
|
|
/* Tests a packet of 4 rays for occlusion occluded with the scene. */
|
|
RTC_API void rtcOccluded4(const int* valid, RTCScene scene, struct RTCRay4* ray, struct RTCOccludedArguments* args RTC_OPTIONAL_ARGUMENT);
|
|
|
|
/* Tests a packet of 8 rays for occlusion with the scene. */
|
|
RTC_API void rtcOccluded8(const int* valid, RTCScene scene, struct RTCRay8* ray, struct RTCOccludedArguments* args RTC_OPTIONAL_ARGUMENT);
|
|
|
|
/* Tests a packet of 16 rays for occlusion with the scene. */
|
|
RTC_API void rtcOccluded16(const int* valid, RTCScene scene, struct RTCRay16* ray, struct RTCOccludedArguments* args RTC_OPTIONAL_ARGUMENT);
|
|
|
|
|
|
/* Forwards single occlusion ray inside user geometry callback. */
|
|
RTC_SYCL_API void rtcForwardOccluded1(const struct RTCOccludedFunctionNArguments* args, RTCScene scene, struct RTCRay* ray, unsigned int instID);
|
|
|
|
/* Forwards single occlusion ray inside user geometry callback. Extended to handle instance arrays using instPrimID parameter. */
|
|
RTC_SYCL_API void rtcForwardOccluded1Ex(const struct RTCOccludedFunctionNArguments* args, RTCScene scene, struct RTCRay* ray, unsigned int instID, unsigned int instPrimID);
|
|
|
|
/* Forwards occlusion ray packet of size 4 inside user geometry callback. */
|
|
RTC_API void rtcForwardOccluded4(const int* valid, const struct RTCOccludedFunctionNArguments* args, RTCScene scene, struct RTCRay4* ray, unsigned int instID);
|
|
|
|
/* Forwards occlusion ray packet of size 4 inside user geometry callback. Extended to handle instance arrays using instPrimID parameter. */
|
|
RTC_API void rtcForwardOccluded4Ex(const int* valid, const struct RTCOccludedFunctionNArguments* args, RTCScene scene, struct RTCRay4* ray, unsigned int instID, unsigned int instPrimID);
|
|
|
|
/* Forwards occlusion ray packet of size 8 inside user geometry callback. */
|
|
RTC_API void rtcForwardOccluded8(const int* valid, const struct RTCOccludedFunctionNArguments* args, RTCScene scene, struct RTCRay8* ray, unsigned int instID);
|
|
|
|
/* Forwards occlusion ray packet of size 8 inside user geometry callback. Extended to handle instance arrays using instPrimID parameter. */
|
|
RTC_API void rtcForwardOccluded8Ex(const int* valid, const struct RTCOccludedFunctionNArguments* args, RTCScene scene, struct RTCRay8* ray, unsigned int instID, unsigned int instPrimID);
|
|
|
|
/* Forwards occlusion ray packet of size 16 inside user geometry callback. */
|
|
RTC_API void rtcForwardOccluded16(const int* valid, const struct RTCOccludedFunctionNArguments* args, RTCScene scene, struct RTCRay16* ray, unsigned int instID);
|
|
|
|
/* Forwards occlusion ray packet of size 16 inside user geometry callback. Extended to handle instance arrays using instPrimID parameter. */
|
|
RTC_API void rtcForwardOccluded16Ex(const int* valid, const struct RTCOccludedFunctionNArguments* args, RTCScene scene, struct RTCRay16* ray, unsigned int instID, unsigned int instPrimID);
|
|
|
|
|
|
/*! collision callback */
|
|
struct RTCCollision { unsigned int geomID0; unsigned int primID0; unsigned int geomID1; unsigned int primID1; };
|
|
typedef void (*RTCCollideFunc) (void* userPtr, struct RTCCollision* collisions, unsigned int num_collisions);
|
|
|
|
/*! Performs collision detection of two scenes */
|
|
RTC_API void rtcCollide (RTCScene scene0, RTCScene scene1, RTCCollideFunc callback, void* userPtr);
|
|
|
|
#if defined(__cplusplus)
|
|
|
|
/* Helper for easily combining scene flags */
|
|
inline RTCSceneFlags operator|(RTCSceneFlags a, RTCSceneFlags b) {
|
|
return (RTCSceneFlags)((size_t)a | (size_t)b);
|
|
}
|
|
|
|
#endif
|
|
|
|
RTC_NAMESPACE_END
|
|
|