Drake
Drake C++ Documentation
drake::geometry::render Namespace Reference

Namespaces

 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  LightType { kPoint = 1, kSpot = 2, kDirectional = 3 }
 Specification of the type of light. More...
 
enum  LightFrame { kWorld = 0, kCamera = 1 }
 Specifies the frame in which a light is fixed. More...
 

Functions

std::ostream & operator<< (std::ostream &out, const LightType &t)
 Writes the LightType as a string. More...
 
LightType light_type_from_string (const std::string &spec)
 Instantiates a LightType from its string representation. More...
 
std::ostream & operator<< (std::ostream &out, const LightFrame &t)
 Writes the LightFrame as a string. More...
 
LightFrame light_frame_from_string (const std::string &spec)
 Instantiates a LightFrame from its string representation. More...
 

Enumeration Type Documentation

◆ LightFrame

enum 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 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 drake::geometry::render::light_frame_from_string ( const std::string &  spec)

Instantiates a LightFrame from its string representation.

Parameters
specMust be one of 'world' or 'camera'.
Exceptions
ifspec is an unrecognized string.

◆ light_type_from_string()

LightType drake::geometry::render::light_type_from_string ( const std::string &  spec)

Instantiates a LightType from its string representation.

Parameters
specMust be one of 'point', 'spot', or 'directional'.
Exceptions
ifspec is an unrecognized string.

◆ operator<<() [1/2]

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

Writes the LightType as a string.

◆ operator<<() [2/2]

std::ostream& drake::geometry::render::operator<< ( std::ostream &  out,
const LightFrame t 
)

Writes the LightFrame as a string.