drake::geometry::render Namespace Reference

Namespaces
namespace	shaders

Classes
class	ClippingRange
	Defines the near and far clipping planes for frustum-based (OpenGL) RenderEngine cameras. More...
class	ColorRenderCamera
	Collection of camera properties for cameras to be used with color/label images. More...
class	DepthRange
	Defines a depth sensor's functional range. More...
class	DepthRenderCamera
	Collection of camera properties for cameras to be used with depth images. More...
struct	LightParameter
	Light parameter for supporting RenderEngine implementations. More...
class	RenderCameraCore
	Collection of core parameters for modeling a pinhole-model camera in a RenderEngine. More...
class	RenderEngine
	The engine for performing rasterization operations on geometry. More...
class	RenderLabel
	Class representing object "labels" for rendering. More...

Enumerations
enum class	LightType { kPoint = 1 , kSpot = 2 , kDirectional = 3 }
	Specification of the type of light. More...
enum class	LightFrame { kWorld = 0 , kCamera = 1 }
	Specifies the frame in which a light is fixed. More...

Functions
std::string_view	to_string (const LightType &t)
	Returns the LightType as a string.
std::ostream &	operator<< (std::ostream &out, const LightType &t)
	(Deprecated.)
LightType	light_type_from_string (const std::string &spec)
	Instantiates a LightType from its string representation.
std::string_view	to_string (const LightFrame &f)
	Returns the LightFrame as a string.
std::ostream &	operator<< (std::ostream &out, const LightFrame &f)
	(Deprecated.)
LightFrame	light_frame_from_string (const std::string &spec)
	Instantiates a LightFrame from its string representation.
std::ostream &	operator<< (std::ostream &out, const RenderLabel &label)
	(Deprecated.)
std::string	to_string (const RenderLabel &label)
	(Deprecated.)

Enumeration Type Documentation

LightFrame

enum class LightFrame

strong

Specifies the frame in which a light is fixed.

Fixing the camera to the world keeps it stationary. Fixing it to the camera moves it with the camera.

Enumerator
kWorld
kCamera

LightType

enum class LightType

strong

Specification of the type of light.

• kPoint: a punctual light source emitting light in all directions.
• kSpot: A conical light source emitting light from a point into a limited set of directions.
• kDirectional: a light source, infinitely far away, casting parallel rays of light (like a sun).

Enumerator
kPoint
kSpot
kDirectional

Function Documentation

light_frame_from_string()

LightFrame light_frame_from_string

(

const std::string &

spec

)

Instantiates a LightFrame from its string representation.

Parameters

spec	Must be one of 'world' or 'camera'.

Exceptions

if	spec is an unrecognized string.

light_type_from_string()

LightType light_type_from_string

(

const std::string &

spec

)

Instantiates a LightType from its string representation.

Parameters

spec	Must be one of 'point', 'spot', or 'directional'.

Exceptions

if	spec is an unrecognized string.

operator<<() [1/3]

std::ostream & operator<<	(	std::ostream &	out,
		const LightFrame &	f )

(Deprecated.)

Deprecated

Use fmt::to_string(), instead
This will be removed from Drake on or after 2026-03-01.

operator<<() [2/3]

std::ostream & operator<<	(	std::ostream &	out,
		const LightType &	t )

(Deprecated.)

Deprecated

Use fmt::to_string(), instead
This will be removed from Drake on or after 2026-03-01.

operator<<() [3/3]

std::ostream & operator<<	(	std::ostream &	out,
		const RenderLabel &	label )

(Deprecated.)

Deprecated

Use fmt::to_string(), instead
This will be removed from Drake on or after 2026-03-01.

to_string() [1/3]

std::string_view to_string

(

const LightFrame &

f

)

Returns the LightFrame as a string.

to_string() [2/3]

std::string_view to_string

(

const LightType &

t

)

Returns the LightType as a string.

to_string() [3/3]

std::string to_string

(

const RenderLabel &

label

)

(Deprecated.)

Deprecated

Use label.to_string(), instead
This will be removed from Drake on or after 2026-03-01.