mf::depth_projection_parameters Struct Reference

Parameters of Z to depth projection. More...

#include <depth_projection_parameters.h>

Public Types
enum	depth_range { signed_normalized, unsigned_normalized, unsigned_normalized_disparity }

Public Member Functions
bool	valid () const
real	depth_min () const
real	depth_max () const

Public Attributes
real	z_near
	Unsigned Z distance of near clipping plane to camera. More...
real	z_far
	Unsigned Z distance of far clipping plane to camera. More...
depth_range	range = unsigned_normalized
	Specifies range of depth values for points in frustum. More...
bool	flip_z = true
	Whether Z axis needs to be reversed, i.e. -Z direction maps to positive depth. More...

Detailed Description

Parameters of Z to depth projection.

Defines how the Z coordinates in view space are mapped to depth values in image space. For points in the direction of camera depth is always positive, and increases with distance to camera. When view space coordinate system is right-handed (camera looks at -Z), flip_z needs to be set.

Member Enumeration Documentation

enum mf::depth_projection_parameters::depth_range

Enumerator
signed_normalized	Depths of points within frustum are in [-1, +1] (OpenGL convention).
unsigned_normalized	Depths of points within frustum are in [0, 1] (DirectX convention).
unsigned_normalized_disparity

Member Function Documentation

real mf::depth_projection_parameters::depth_max ( ) const

inline

real mf::depth_projection_parameters::depth_min ( ) const

inline

bool mf::depth_projection_parameters::valid

(

)

const

Member Data Documentation

bool mf::depth_projection_parameters::flip_z = true

Whether Z axis needs to be reversed, i.e. -Z direction maps to positive depth.

depth_range mf::depth_projection_parameters::range = unsigned_normalized

Specifies range of depth values for points in frustum.

real mf::depth_projection_parameters::z_far

Unsigned Z distance of far clipping plane to camera.

real mf::depth_projection_parameters::z_near

Unsigned Z distance of near clipping plane to camera.

---

The documentation for this struct was generated from the following files:

• src/geometry/depth_projection_parameters.h
• src/geometry/depth_projection_parameters.cc