Viewport definition either for a render surface or the backbuffer. More...

#include <Urho3D/Graphics/Viewport.h>

Inheritance diagram for Urho3D::Viewport:

Public Member Functions
	Viewport (Context *context)
	Construct with defaults.

	Viewport (Context context, Scene scene, Camera *camera)
	Construct with a full rectangle.

	Viewport (Context context, Scene scene, Camera *camera, const IntRect &rect)
	Construct with a specified rectangle.

	Viewport (Context context, Scene scene, Camera camera, const IntRect &rect, RenderPipeline renderPipeline)
	Construct with a specified rectangle and render pipeline.

	Viewport (Context context, Scene scene, Camera leftEye, Camera rightEye, RenderPipeline *renderPipeline)
	Construct for stereo with a render pipeline.

	~Viewport () override
	Destruct.

void	SetScene (Scene *scene)

void	SetCamera (Camera *camera)

void	SetRect (const IntRect &rect)

void	SetDrawDebug (bool enable)

void	SetCullCamera (Camera *camera)

Scene *	GetScene () const

Camera *	GetCamera () const

RenderPipelineView *	GetRenderPipelineView () const
	Return render pipeline.

const IntRect &	GetRect () const

IntRect	GetEffectiveRect (RenderSurface *renderTarget, bool compensateRenderTargetFlip=true) const

bool	GetDrawDebug () const

Camera *	GetCullCamera () const

Ray	GetScreenRay (int x, int y) const
	Return ray corresponding to normalized screen coordinates.

IntVector2	WorldToScreenPoint (const Vector3 &worldPos) const
	Convert a world space point to normalized screen coordinates. More...

Vector3	ScreenToWorldPoint (int x, int y, float depth) const
	Convert screen coordinates and depth to a world space point. More...

void	AllocateView ()
	Allocate the view structure. Called by Renderer.

Camera *	GetEye (int) const
	Get the given eye by index, starting from the left.

void	SetEye (Camera *camera, int eyeIdx)
	Set a camera based on eye-index, starting from the left.

bool	IsStereo () const
	Returns true if this viewport has "eyes" for stereo.

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.

template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.

template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.

template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.

void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.

void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.

void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.

void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.

void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.

void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

void	SendEvent (StringHash eventType)
	Send event to all subscribers.

void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.

VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.

Object *	GetEventSender () const
	Return active event sender. Null outside event handling.

EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.

bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.

bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.

bool	HasEventHandlers () const
	Return whether has subscribed to any event.

template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.

const ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

void	SetBlockEvents (bool block)
	Block object from sending and receiving events.

bool	GetBlockEvents () const
	Return sending and receiving events blocking status.

Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.

virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object with the engine.

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (Viewport, Object)

Private Attributes
WeakPtr< Scene >	scene_
	Scene pointer.

WeakPtr< Camera >	camera_
	Camera pointer.

WeakPtr< Camera >	rightEye_
	Right eye camera pointer.

WeakPtr< Camera >	cullCamera_
	Culling camera pointer.

IntRect	rect_
	Viewport rectangle.

bool	drawDebug_
	Debug draw flag.

bool	autoRenderPipeline_ {true}
	Whether to search for render pipeline automatically.

WeakPtr< RenderPipeline >	renderPipeline_
	Render pipeline component from scene_.

SharedPtr< RenderPipelineView >	renderPipelineView_
	Instance of render pipeline connected to renderPipeline_.

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Viewport definition either for a render surface or the backbuffer.

Member Function Documentation

◆ GetCamera()

Camera * Urho3D::Viewport::GetCamera ( ) const

Return viewport camera.

◆ GetCullCamera()

Camera * Urho3D::Viewport::GetCullCamera ( ) const

Return the culling camera. If null, the viewport camera will be used for culling (normal case).

◆ GetDrawDebug()

bool Urho3D::Viewport::GetDrawDebug ( ) const

inline

Return whether to draw debug geometry.

◆ GetEffectiveRect()

IntRect Urho3D::Viewport::GetEffectiveRect	(	RenderSurface *	renderTarget,
		bool	compensateRenderTargetFlip = `true`
	)		const

Return effective view rectangle. By default, this function compensates for render target flip on OpenGL. It may be disabled.

◆ GetRect()

const IntRect& Urho3D::Viewport::GetRect ( ) const

inline

Return view rectangle. A zero rectangle (0 0 0 0) means to use the rendertarget's full dimensions. In this case you could fetch the actual view rectangle from View object, though it will be valid only after the first frame.

◆ GetScene()

Scene * Urho3D::Viewport::GetScene ( ) const

Return scene.

◆ ScreenToWorldPoint()

Vector3 Urho3D::Viewport::ScreenToWorldPoint	(	int	x,
		int	y,
		float	depth
	)		const

Convert screen coordinates and depth to a world space point.

◆ SetCamera()

void Urho3D::Viewport::SetCamera ( Camera * camera )

Set viewport camera.

◆ SetCullCamera()

void Urho3D::Viewport::SetCullCamera ( Camera * camera )

Set separate camera to use for culling. Sharing a culling camera between several viewports allows to prepare the view only once, saving in CPU use. The culling camera's frustum should cover all the viewport cameras' frusta or else objects may be missing from the rendered view.

◆ SetDrawDebug()

void Urho3D::Viewport::SetDrawDebug ( bool enable )

Set whether to render debug geometry. Default true.

◆ SetRect()

void Urho3D::Viewport::SetRect ( const IntRect & rect )

Set view rectangle. A zero rectangle (0 0 0 0) means to use the rendertarget's full dimensions.

◆ SetScene()

void Urho3D::Viewport::SetScene ( Scene * scene )

Set scene.

◆ WorldToScreenPoint()

IntVector2 Urho3D::Viewport::WorldToScreenPoint ( const Vector3 & worldPos ) const

Convert a world space point to normalized screen coordinates.

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

Urho3D/Graphics/Viewport.h
Urho3D/Graphics/Viewport.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members