LDKDebugDraw
typedef struct LDKDebugDraw{
LDKRenderer *renderer;
LDKRendererViewId view_id;
float thickness;
u32 color;
bool depth_test;
}LDKDebugDraw;ldk_debug_draw.h
homeDebug drawing
Transient 3D debug geometry, available to editor and game builds. All distances, including thickness, are in world units. Colors: 0xRRGGBBAA. No global state or ownership: the context can be kept or copied by callers. Call on the render thread before render_frame, and resubmit every frame. Helpers return false on invalid arguments or submission failure. A failed helper may have submitted part of its shape. Tessellation: 3..4096 segments.
ldk_debug_draw_make
Create a debug drawing context for a renderer view.
LDK_API LDKDebugDraw ldk_debug_draw_make(
LDKRenderer *renderer,
LDKRendererViewId view_id
);Parameters
LDKRenderer *renderer- Renderer receiving this request.
LDKRendererViewId view_id- Renderer view receiving this operation.
Returns
The requested value.
ldk_debug_draw_line
Draw a line between two 3D positions.
LDK_API bool ldk_debug_draw_line(
const LDKDebugDraw *draw,
Vec3 start,
Vec3 end
);Parameters
const LDKDebugDraw *draw- Debug drawing context.
Vec3 start- Starting timestamp or location for this operation.
Vec3 end- Ending timestamp or location for this operation.
Returns
True if the operation succeeds; false otherwise.
ldk_debug_draw_arrow
Draw a directional arrow between two 3D positions.
LDK_API bool ldk_debug_draw_arrow(
const LDKDebugDraw *draw,
Vec3 start,
Vec3 end
);Parameters
const LDKDebugDraw *draw- Debug drawing context.
Vec3 start- Starting timestamp or location for this operation.
Vec3 end- Ending timestamp or location for this operation.
Returns
True if the operation succeeds; false otherwise.
ldk_debug_draw_axes
Draw coordinate axes using a world transform.
LDK_API bool ldk_debug_draw_axes(
const LDKDebugDraw *draw,
Mat4 world,
float length
);Parameters
const LDKDebugDraw *draw- Debug drawing context.
Mat4 world- Object-to-world transformation matrix.
float length- Length used by this operation.
Returns
True if the operation succeeds; false otherwise.
ldk_debug_draw_box
Draw an axis-aligned 3D bounding box.
LDK_API bool ldk_debug_draw_box(
const LDKDebugDraw *draw,
Vec3 minimum,
Vec3 maximum
);Parameters
const LDKDebugDraw *draw- Debug drawing context.
Vec3 minimum- Minimum used by this operation.
Vec3 maximum- Maximum used by this operation.
Returns
True if the operation succeeds; false otherwise.
ldk_debug_draw_circle
Draw a circle in 3D space.
LDK_API bool ldk_debug_draw_circle(
const LDKDebugDraw *draw,
Vec3 center,
Vec3 normal,
float radius,
u32 segments
);Parameters
const LDKDebugDraw *draw- Debug drawing context.
Vec3 center- Center of the geometry.
Vec3 normal- Surface normal vector.
float radius- Interaction or geometry radius.
u32 segments- Segments used by this operation.
Returns
True if the operation succeeds; false otherwise.
ldk_debug_draw_sphere
Draw a wireframe sphere in 3D space.
LDK_API bool ldk_debug_draw_sphere(
const LDKDebugDraw *draw,
Vec3 center,
float radius,
u32 segments
);Parameters
const LDKDebugDraw *draw- Debug drawing context.
Vec3 center- Center of the geometry.
float radius- Interaction or geometry radius.
u32 segments- Segments used by this operation.
Returns
True if the operation succeeds; false otherwise.
ldk_debug_draw_cone
Draw a wireframe cone in 3D space.
LDK_API bool ldk_debug_draw_cone(
const LDKDebugDraw *draw,
Vec3 apex,
Vec3 direction,
float height,
float radius,
u32 segments
);Parameters
const LDKDebugDraw *draw- Debug drawing context.
Vec3 apex- Apex used by this operation.
Vec3 direction- Direction used by this operation.
float height- Height in pixels or the units expected by the API.
float radius- Interaction or geometry radius.
u32 segments- Segments used by this operation.
Returns
True if the operation succeeds; false otherwise.
ldk_debug_draw_frustum
Draw a camera or projection frustum.
LDK_API bool ldk_debug_draw_frustum(
const LDKDebugDraw *draw,
Mat4 inverse_view_projection
);Parameters
const LDKDebugDraw *draw- Debug drawing context.
Mat4 inverse_view_projection- Inverse view projection used by this operation.
Returns
True if the operation succeeds; false otherwise.