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

Graphe d'héritage de castor3d::RenderWindow:

Graphe de collaboration de castor3d::RenderWindow:

Classes
class	InputListener

Fonctions membres publiques
C3D_API	RenderWindow (castor::String const &name, Engine &engine)
	Constructor. Plus de détails...
C3D_API	~RenderWindow ()
	Destructeur. Plus de détails...
C3D_API bool	initialise (castor::Size const &size, ashes::WindowHandle handle)
	Définit l'identifiant de la fenêtre, initialise la fenêtre. Plus de détails...
C3D_API void	cleanup ()
	Nettoie l'instance. Plus de détails...
C3D_API void	render (bool signalOnly)
	Renders one frame. Plus de détails...
C3D_API void	resize (uint32_t x, uint32_t y)
	Redimensionne la fenêtre. Plus de détails...
C3D_API void	resize (castor::Size const &size)
	Redimensionne la fenêtre. Plus de détails...
C3D_API void	setCamera (CameraSPtr camera)
	Définit la caméra. Plus de détails...
C3D_API void	enableFullScreen (bool value)
	Change le statut de plein écran. Plus de détails...
C3D_API SceneSPtr	getScene () const
C3D_API CameraSPtr	getCamera () const
C3D_API ViewportType	getViewportType () const
C3D_API void	setViewportType (ViewportType value)
	Définit le ViewportType. Plus de détails...
C3D_API void	setScene (SceneSPtr value)
	Définit la Scene. Plus de détails...
C3D_API castor::Size	getSize () const
C3D_API bool	isUsingStereo () const
C3D_API void	setStereo (bool stereo)
	Définit le statut d'utilisation stéréo. Plus de détails...
C3D_API float	getIntraOcularDistance () const
	Récupère la distance inter oculaire. Plus de détails...
C3D_API void	setIntraOcularDistance (float intraOcularDistance)
	Définit la distance inter oculaire. Plus de détails...
C3D_API VkFormat	getPixelFormat () const
C3D_API void	setPixelFormat (VkFormat value)
	Définit le format des pixels de la fenêtre. Plus de détails...
C3D_API void	addPickingScene (Scene &scene)
	Ajoute une scène qui peut être pickée. Plus de détails...
C3D_API PickNodeType	pick (castor::Position const &position)
	Sélectionne la géométrie à la position de souris donnée. Plus de détails...
uint32_t	getIndex () const
bool	isInitialised () const
FrameListenerSPtr	getListener () const
RenderDevice const &	getDevice () const
RenderTargetSPtr	getRenderTarget () const
bool	isVSyncEnabled () const
bool	isFullscreen () const
castor::PxBufferBaseSPtr	getSavedFrame () const
bool	isPickingDebugEnabled () const
void	enablePickingDebug (bool v)
C3D_API GeometrySPtr	getPickedGeometry () const
C3D_API BillboardBaseSPtr	getPickedBillboard () const
C3D_API SubmeshSPtr	getPickedSubmesh () const
C3D_API uint32_t	getPickedFace () const
void	setRenderTarget (RenderTargetSPtr value)
void	setDevice (RenderDeviceSPtr value)
void	enableVSync (bool value)
void	setFullscreen (bool value)
void	enableSaveFrame ()
Fonctions membres publiques hérités de castor3d::MouseEventHandler
	MouseEventHandler ()
Fonctions membres publiques hérités de castor3d::EventHandler
	EventHandler (bool catchMouseEvents)
virtual	~EventHandler ()
void	processEvents ()
void	pushEvent (MouseEvent const &event)
void	connect (MouseEventType event, ClientMouseFunction function)
void	pushEvent (KeyboardEvent const &event)
void	connect (KeyboardEventType event, ClientKeyboardFunction function)
bool	catchesMouseEvents () const
void	setCatchesMouseEvents (bool value)
void	pushEvent (HandlerEvent const &event)
void	connect (HandlerEventType event, ClientHandlerFunction function)
bool	catchesTabKey () const
bool	catchesReturnKey () const

Membres hérités additionnels
Types publics hérités de castor3d::EventHandler
using	ClientMouseFunction = std::function< void(MouseEvent const &) >
using	ClientKeyboardFunction = std::function< void(KeyboardEvent const &) >
using	ClientHandlerFunction = std::function< void(HandlerEvent const &) >
using	OnClientMouseEvent = castor::Signal< ClientMouseFunction >
using	OnClientKeyboardEvent = castor::Signal< ClientKeyboardFunction >
using	OnClientHandlerEvent = castor::Signal< ClientHandlerFunction >
using	OnClientMouseEventConnection = OnClientMouseEvent::connection
using	OnClientKeyboardEventConnection = OnClientKeyboardEvent::connection
using	OnClientHandlerEventConnection = OnClientHandlerEvent::connection
Types protégés hérités de castor3d::EventHandler
using	EventHandlerFunction = std::function< void() >
using	EventQueue = std::deque< std::pair< UserInputEventSPtr, EventHandlerFunction > >
Fonctions membres protégées hérités de castor3d::EventHandler
void	processMouseEvent (MouseEventSPtr event)
void	processKeyboardEvent (KeyboardEventSPtr event)
void	processHandlerEvent (HandlerEventSPtr event)
Attributs protégés hérités de castor3d::EventHandler
std::array< OnClientMouseEvent, size_t(MouseEventType::eCount) >	m_mouseSlots
std::array< std::vector< OnClientMouseEventConnection >, size_t(MouseEventType::eCount) >	m_mouseSlotsConnections
std::array< OnClientKeyboardEvent, size_t(KeyboardEventType::eCount) >	m_keyboardSlots
std::array< std::vector< OnClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) >	m_keyboardSlotsConnections
std::array< OnClientHandlerEvent, size_t(HandlerEventType::eCount) >	m_handlerSlots
std::array< std::vector< OnClientHandlerEventConnection >, size_t(HandlerEventType::eCount) >	m_handlerSlotsConnections

Documentation des constructeurs et destructeur

RenderWindow()

C3D_API castor3d::RenderWindow::RenderWindow	(	castor::String const &	name,
		Engine &	engine
	)

Constructor.

Paramètres

[in]	engine	Le moteur.
[in]	name	Le nom de la fenêtre.

~RenderWindow()

C3D_API castor3d::RenderWindow::~RenderWindow

(

)

Destructeur.

Documentation des fonctions membres

addPickingScene()

C3D_API void castor3d::RenderWindow::addPickingScene

(

Scene &

scene

)

Ajoute une scène qui peut être pickée.

Paramètres

[in]

scene

La scène.

cleanup()

C3D_API void castor3d::RenderWindow::cleanup

(

)

Nettoie l'instance.

enableFullScreen()

C3D_API void castor3d::RenderWindow::enableFullScreen

(

bool

value

)

Change le statut de plein écran.

Paramètres

[in]

value

Le nouveau statut.

enablePickingDebug()

void castor3d::RenderWindow::enablePickingDebug ( bool  v )

inline

enableSaveFrame()

void castor3d::RenderWindow::enableSaveFrame ( )

inline

enableVSync()

void castor3d::RenderWindow::enableVSync ( bool  value )

inline

getCamera()

C3D_API CameraSPtr castor3d::RenderWindow::getCamera

(

)

const

Renvoie

La caméra.

getDevice()

RenderDevice const& castor3d::RenderWindow::getDevice ( ) const

inline

getIndex()

uint32_t castor3d::RenderWindow::getIndex ( ) const

inline

name Accesseurs.

getIntraOcularDistance()

C3D_API float castor3d::RenderWindow::getIntraOcularDistance

(

)

const

Récupère la distance inter oculaire.

Renvoie

La distance inter oculaire

getListener()

FrameListenerSPtr castor3d::RenderWindow::getListener ( ) const

inline

getPickedBillboard()

C3D_API BillboardBaseSPtr castor3d::RenderWindow::getPickedBillboard

(

)

const

getPickedFace()

C3D_API uint32_t castor3d::RenderWindow::getPickedFace

(

)

const

getPickedGeometry()

C3D_API GeometrySPtr castor3d::RenderWindow::getPickedGeometry

(

)

const

getPickedSubmesh()

C3D_API SubmeshSPtr castor3d::RenderWindow::getPickedSubmesh

(

)

const

getPixelFormat()

C3D_API VkFormat castor3d::RenderWindow::getPixelFormat

(

)

const

Renvoie

Le format des pixels de la fenêtre.

getRenderTarget()

RenderTargetSPtr castor3d::RenderWindow::getRenderTarget ( ) const

inline

getSavedFrame()

castor::PxBufferBaseSPtr castor3d::RenderWindow::getSavedFrame ( ) const

inline

getScene()

C3D_API SceneSPtr castor3d::RenderWindow::getScene

(

)

const

Renvoie

La scène.

getSize()

C3D_API castor::Size castor3d::RenderWindow::getSize

(

)

const

Renvoie

Les dimensions de la fenêtre.

getViewportType()

C3D_API ViewportType castor3d::RenderWindow::getViewportType

(

)

const

Renvoie

Le ViewportType.

initialise()

C3D_API bool castor3d::RenderWindow::initialise	(	castor::Size const &	size,
		ashes::WindowHandle	handle
	)

Définit l'identifiant de la fenêtre, initialise la fenêtre.

Paramètres

[in]	size	Les dimensions de la fenêtre.
[in]	handle	Le handle de la fenêtre native.

Renvoie

false si un problème quelconque a été rencontré.

isFullscreen()

bool castor3d::RenderWindow::isFullscreen ( ) const

inline

isInitialised()

bool castor3d::RenderWindow::isInitialised ( ) const

inline

isPickingDebugEnabled()

bool castor3d::RenderWindow::isPickingDebugEnabled ( ) const

inline

isUsingStereo()

C3D_API bool castor3d::RenderWindow::isUsingStereo

(

)

const

Renvoie

true si le rendu stéréo est utilisé.

isVSyncEnabled()

bool castor3d::RenderWindow::isVSyncEnabled ( ) const

inline

pick()

C3D_API PickNodeType castor3d::RenderWindow::pick

(

castor::Position const &

position

)

Sélectionne la géométrie à la position de souris donnée.

Paramètres

[in]

position

La position dans la passe.

Renvoie

PickNodeType si rien n'a été pické.

render()

C3D_API void castor3d::RenderWindow::render

(

bool

signalOnly

)

Renders one frame.

Paramètres

[in]

signalOnly

true pour ne faire que signaler les semaphores.

resize() [1/2]

C3D_API void castor3d::RenderWindow::resize	(	uint32_t	x,
		uint32_t	y
	)

Redimensionne la fenêtre.

Paramètres

[in]

x,y

Les nouvelles dimensions.

resize() [2/2]

C3D_API void castor3d::RenderWindow::resize

(

castor::Size const &

size

)

Redimensionne la fenêtre.

Paramètres

[in]

size

Les nouvelles dimensions.

setCamera()

C3D_API void castor3d::RenderWindow::setCamera

(

CameraSPtr

camera

)

Définit la caméra.

Paramètres

[in]

camera

La caméra.

setDevice()

void castor3d::RenderWindow::setDevice ( RenderDeviceSPtr  value )

inline

setFullscreen()

void castor3d::RenderWindow::setFullscreen ( bool  value )

inline

setIntraOcularDistance()

C3D_API void castor3d::RenderWindow::setIntraOcularDistance

(

float

intraOcularDistance

)

Définit la distance inter oculaire.

Paramètres

[in]

intraOcularDistance

La distance inter oculaire.

setPixelFormat()

C3D_API void castor3d::RenderWindow::setPixelFormat

(

VkFormat

value

)

Définit le format des pixels de la fenêtre.

Paramètres

[in]

value

Le nouveau format des pixels de la fenêtre.

setRenderTarget()

void castor3d::RenderWindow::setRenderTarget ( RenderTargetSPtr  value )

inline

name Mutateurs.

setScene()

C3D_API void castor3d::RenderWindow::setScene

(

SceneSPtr

value

)

Définit la Scene.

Paramètres

[in]

value

La nouvelle valeur.

setStereo()

C3D_API void castor3d::RenderWindow::setStereo

(

bool

stereo

)

Définit le statut d'utilisation stéréo.

Paramètres

[in]

stereo

true si le rendu stéréo est à utiliser.

setViewportType()

C3D_API void castor3d::RenderWindow::setViewportType

(

ViewportType

value

)

Définit le ViewportType.

Paramètres

[in]

value

La nouvelle valeur.

---

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

• Render/RenderWindow.hpp