Référence de la classe castor3d::Viewport

#include <Viewport.hpp>

Graphe de collaboration de castor3d::Viewport:

Fonctions membres publiques
C3D_API Viewport &	operator= (Viewport const &rhs)=delete
C3D_API Viewport &	operator= (Viewport &&rhs)=delete
C3D_API	Viewport (Viewport const &rhs)
C3D_API	Viewport (Viewport &&rhs)
C3D_API	Viewport (Engine const &engine)
	Constructeur.
C3D_API	~Viewport ()=default
	Destructeur.
C3D_API bool	update ()
	Applique la perspective.
C3D_API void	setPerspective (castor::Angle const &fovy, float aspect, float nearZ, float farZ)
	Construit vioewport en perspective centrée.
C3D_API void	setInfinitePerspective (castor::Angle const &fovy, float aspect, float nearZ)
	Construit vioewport en perspective centrée avec plan éloigné infini.
C3D_API void	setFrustum (float left, float right, float bottom, float top, float nearZ, float farZ)
	Construit une matrice de projection en perspective non centrée.
C3D_API void	setOrtho (float left, float right, float bottom, float top, float nearZ, float farZ)
	Construit une matrice de projection orthographique.
C3D_API void	resize (const castor::Size &value)
	Définit les dimensions de rendu du viewport.
C3D_API float	getProjectionScale () const
C3D_API castor::Matrix4x4f	getRescaledProjection (float scale) const
C3D_API castor::Matrix4x4f	getRescaledSafeBandedProjection (float scale) const
castor::Size const &	getSize () const
castor::Position const &	getPosition () const
ViewportType	getType () const
float	getRatio () const
float	getNear () const
float	getFar () const
castor::Angle const &	getFovY () const
float	getLeft () const
float	getRight () const
float	getTop () const
float	getBottom () const
uint32_t	getWidth () const
uint32_t	getHeight () const
bool	isModified () const
castor::Matrix4x4f const &	getProjection () const
castor::Matrix4x4f const &	getSafeBandedProjection () const
VkViewport const &	getViewport () const
VkRect2D const &	getScissor () const
Engine const &	getEngine () const
void	setPosition (const castor::Position &value)
void	updateType (ViewportType value)
void	updateRatio (float value)
void	updateNear (float value)
void	updateFar (float value)
void	updateFovY (castor::Angle const &value)
void	updateLeft (float value)
void	updateRight (float value)
void	updateTop (float value)
void	updateBottom (float value)

Attributs publics statiques
static C3D_API const std::array< castor::String, size_t(ViewportType::eCount) >	TypeName

Documentation des constructeurs et destructeur

Viewport() [1/3]

C3D_API castor3d::Viewport::Viewport

(

Viewport const &

rhs

)

Viewport() [2/3]

C3D_API castor3d::Viewport::Viewport

(

Viewport &&

rhs

)

Viewport() [3/3]

C3D_API castor3d::Viewport::Viewport ( Engine const &  engine )

explicit

Constructeur.

Paramètres

[in]

engine

Le moteur.

~Viewport()

C3D_API castor3d::Viewport::~Viewport ( )

default

Destructeur.

Documentation des fonctions membres

getBottom()

float castor3d::Viewport::getBottom ( ) const

inline

getEngine()

Engine const & castor3d::Viewport::getEngine ( ) const

inline

getFar()

float castor3d::Viewport::getFar ( ) const

inline

Référencé par castor3d::Camera::getFar().

Voici le graphe des appelants de cette fonction :

getFovY()

castor::Angle const & castor3d::Viewport::getFovY ( ) const

inline

Référencé par castor3d::Camera::getFovY().

Voici le graphe des appelants de cette fonction :

getHeight()

uint32_t castor3d::Viewport::getHeight ( ) const

inline

Référencé par castor3d::Camera::getHeight().

Voici le graphe des appelants de cette fonction :

getLeft()

float castor3d::Viewport::getLeft ( ) const

inline

getNear()

float castor3d::Viewport::getNear ( ) const

inline

Référencé par castor3d::Camera::getNear().

Voici le graphe des appelants de cette fonction :

getPosition()

castor::Position const & castor3d::Viewport::getPosition ( ) const

inline

getProjection()

castor::Matrix4x4f const & castor3d::Viewport::getProjection ( ) const

inline

Référencé par castor3d::Camera::getProjection().

Voici le graphe des appelants de cette fonction :

getProjectionScale()

C3D_API float castor3d::Viewport::getProjectionScale

(

)

const

Renvoie

Le nombre de pixels par mètre, pour z = -1.

Référencé par castor3d::Camera::getProjectionScale().

Voici le graphe des appelants de cette fonction :

getRatio()

float castor3d::Viewport::getRatio ( ) const

inline

Référencé par castor3d::Camera::getRatio().

Voici le graphe des appelants de cette fonction :

getRescaledProjection()

C3D_API castor::Matrix4x4f castor3d::Viewport::getRescaledProjection

(

float

scale

)

const

name Accesseurs.

getRescaledSafeBandedProjection()

C3D_API castor::Matrix4x4f castor3d::Viewport::getRescaledSafeBandedProjection

(

float

scale

)

const

getRight()

float castor3d::Viewport::getRight ( ) const

inline

getSafeBandedProjection()

castor::Matrix4x4f const & castor3d::Viewport::getSafeBandedProjection ( ) const

inline

Référencé par castor3d::Camera::getProjection().

Voici le graphe des appelants de cette fonction :

getScissor()

VkRect2D const & castor3d::Viewport::getScissor ( ) const

inline

getSize()

castor::Size const & castor3d::Viewport::getSize ( ) const

inline

Référencé par castor3d::Camera::getSize(), et castor3d::Camera::resize().

Voici le graphe des appelants de cette fonction :

getTop()

float castor3d::Viewport::getTop ( ) const

inline

getType()

ViewportType castor3d::Viewport::getType ( ) const

inline

Référencé par castor3d::Camera::getViewportType().

Voici le graphe des appelants de cette fonction :

getViewport()

VkViewport const & castor3d::Viewport::getViewport ( ) const

inline

getWidth()

uint32_t castor3d::Viewport::getWidth ( ) const

inline

Référencé par castor3d::Camera::getWidth().

Voici le graphe des appelants de cette fonction :

isModified()

bool castor3d::Viewport::isModified ( ) const

inline

operator=() [1/2]

C3D_API Viewport & castor3d::Viewport::operator= ( Viewport &&  rhs )

delete

operator=() [2/2]

C3D_API Viewport & castor3d::Viewport::operator= ( Viewport const &  rhs )

delete

resize()

C3D_API void castor3d::Viewport::resize

(

const castor::Size &

value

)

Définit les dimensions de rendu du viewport.

Paramètres

[in]

value

La nouvelle valeur

Référencé par castor3d::Camera::resize().

Voici le graphe des appelants de cette fonction :

setFrustum()

C3D_API void castor3d::Viewport::setFrustum	(	float	left,
		float	right,
		float	bottom,
		float	top,
		float	nearZ,
		float	farZ
	)

Construit une matrice de projection en perspective non centrée.

Paramètres

[in]	left	Position du plan gauche.
[in]	right	Position du plan droit.
[in]	bottom	Position du plan bas.
[in]	top	Position du plan haut.
[in]	nearZ	Position du plan proche.
[in]	farZ	Position du plan éloigné.

setInfinitePerspective()

C3D_API void castor3d::Viewport::setInfinitePerspective	(	castor::Angle const &	fovy,
		float	aspect,
		float	nearZ
	)

Construit vioewport en perspective centrée avec plan éloigné infini.

Paramètres

[in]	fovy	Angle de vision Y.
[in]	aspect	Ratio Largeur / Hauteur.
[in]	nearZ	Position du plan proche.

setOrtho()

C3D_API void castor3d::Viewport::setOrtho	(	float	left,
		float	right,
		float	bottom,
		float	top,
		float	nearZ,
		float	farZ
	)

Construit une matrice de projection orthographique.

Paramètres

[in]	left	Position du plan gauche.
[in]	right	Position du plan droit.
[in]	bottom	Position du plan bas.
[in]	top	Position du plan haut.
[in]	nearZ	Position du plan proche.
[in]	farZ	Position du plan éloigné.

setPerspective()

C3D_API void castor3d::Viewport::setPerspective	(	castor::Angle const &	fovy,
		float	aspect,
		float	nearZ,
		float	farZ
	)

Construit vioewport en perspective centrée.

Paramètres

[in]	fovy	Angle de vision Y.
[in]	aspect	Ratio Largeur / Hauteur.
[in]	nearZ	Position du plan proche.
[in]	farZ	Position du plan éloigné.

setPosition()

void castor3d::Viewport::setPosition ( const castor::Position &  value )

inline

name Mutateurs.

update()

C3D_API bool castor3d::Viewport::update

(

)

Applique la perspective.

Renvoie

true si le frustum de vue a été modifié

updateBottom()

void castor3d::Viewport::updateBottom ( float  value )

inline

updateFar()

void castor3d::Viewport::updateFar ( float  value )

inline

updateFovY()

void castor3d::Viewport::updateFovY ( castor::Angle const &  value )

inline

updateLeft()

void castor3d::Viewport::updateLeft ( float  value )

inline

updateNear()

void castor3d::Viewport::updateNear ( float  value )

inline

updateRatio()

void castor3d::Viewport::updateRatio ( float  value )

inline

updateRight()

void castor3d::Viewport::updateRight ( float  value )

inline

updateTop()

void castor3d::Viewport::updateTop ( float  value )

inline

updateType()

void castor3d::Viewport::updateType ( ViewportType  value )

inline

Référencé par castor3d::Camera::setViewportType().

Voici le graphe des appelants de cette fonction :

Documentation des données membres

TypeName

C3D_API const std::array< castor::String, size_t( ViewportType::eCount ) > castor3d::Viewport::TypeName

static

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Render/Viewport.hpp