#include <LSceneView.h>

View for rendering other views. More...

Detailed Description

View for rendering other views.

An LSceneView is a unique type of view. Instead of rendering its content directly into an LOutput, it possesses its own framebuffer. This capability allows for advanced blending effects, such as applying masks (check LView::setBlendFunc()).

Unlike other Views, child views of an LSceneView are always clipped to the boundaries of the LSceneView rectangle. LSceneViews can function as children of other views or LSceneViews (just like any other view), but they can also operate independently. For example, you might create an LSceneView, populate it with arranged views, execute the render() function, and then use that output as a texture for other porpuses.

The main view of the LScene class (LScene::mainView()) is a unique LSceneView designed to render its content onto one or more LOutputs instead of using its own framebuffer.

Warning: Use LSceneViews judiciously. When nested within another scene, they are rendered twice: first, the scene renders itself to its framebuffer, and then its parent scene renders that to itself as well or into an LOutput framebuffer.

Public Member Functions
	LSceneView (const LSize &sizeB, Float32 bufferScale, LView *parent=nullptr)
	Construct an LSceneView with a specified buffer size, buffer scale, and optional parent. More...

	~LSceneView ()
	Destructor for the LSceneView. More...

const LRGBAF &	clearColor () const
	Retrieve the clear color of the scene view. More...

void	setClearColor (Float32 r, Float32 g, Float32 b, Float32 a)
	Set the clear color of the scene view using individual RGBA components. More...

void	setClearColor (const LRGBAF &color)
	Set the clear color of the scene view using an LRGBAF color. More...

void	damageAll (LOutput *output)
	Apply damage to all areas of the scene view for a specific output. More...

void	addDamage (LOutput *output, const LRegion &damage)
	Add specific damage areas to the scene view for a specific output. More...

bool	isLScene () const
	Check if the view is the main view of an LScene. More...

virtual void	render (const LRegion *exclude=nullptr)
	Render the scene. More...

virtual LTexture *	texture (Int32 index=0) const
	Retrieve the texture associated with the view. More...

void	setPos (const LPoint &pos)
	Set the position of the scene. More...

void	setPos (Int32 x, Int32 y)
	Set the position of the scene using X and Y coordinates. More...

void	setSizeB (const LSize &size)
	Set the size of the scene framebuffer. More...

void	setScale (Float32 scale)
	Set the scale factor for the scene framebuffer. More...

virtual bool	nativeMapped () const override
	Tells whether the view should be rendered. More...

virtual const LPoint &	nativePos () const override
	Get the position of the view without any transformations applied. More...

virtual const LSize &	nativeSize () const override
	Get the size of the view without any transformations applied. More...

virtual Float32	bufferScale () const override
	Get the scale of the view buffer content. More...

virtual void	enteredOutput (LOutput *output) override
	Indicate that the view is visible on the given output. More...

virtual void	leftOutput (LOutput *output) override
	Indicate that the view is no longer visible on the given output. More...

virtual const std::vector< LOutput * > &	outputs () const override
	Get a vector of output pointers on which the view is currently visible. More...

virtual bool	isRenderable () const override
	Check if the view is itself renderable. More...

virtual void	requestNextFrame (LOutput *output) override
	Notify that the view has been rendered on the given output. More...

virtual const LRegion *	damage () const override
	Get the region within the view rect that needs to be repainted. More...

virtual const LRegion *	translucentRegion () const override
	Returns the translucent region within the view rectangle. More...

virtual const LRegion *	opaqueRegion () const override
	Returns the opaque region within the view rectangle. More...

virtual const LRegion *	inputRegion () const override
	Region within the view rect that can receive input events (when the inputEnabled() property is enabled). More...

virtual void	paintEvent (const PaintEventParams &params) override
	Request to paint a region of the view to the current framebuffer. More...

Public Member Functions inherited from LView
	LView (UInt32 type, LView *parent=nullptr)
	Construct an LView object. More...

virtual	~LView ()
	Destructor for the LView class. More...

void	damageAll ()
	Forces a complete repaint of the view in the next rendering frame. More...

LScene *	scene () const
	Get the scene in which this view is currently embedded. More...

LSceneView *	parentSceneView () const
	Get the LSceneView in which this view is currently embedded. More...

UInt32	type () const
	Get the identifier for the type of view. More...

void	repaint ()
	Schedule a repaint for all outputs where this view is currently visible. More...

LView *	parent () const
	Get the parent of the view. More...

void	setParent (LView *view)
	Set the new parent for the view and insert it at the end of its children list. More...

void	insertAfter (LView *prev, bool switchParent=true)
	Insert the view after the 'prev' view. More...

std::list< LView * > &	children () const
	Get the list of child views. More...

bool	parentOffsetEnabled () const
	Check if the parent's offset is applied to the view position. More...

void	enableParentOffset (bool enabled)
	Enable or disable the parent's offset for the view position. More...

const LPoint &	pos () const
	Get the current position of the view with applied transformations. More...

const LSize &	size () const
	Get the current size of the view with applied transformations. More...

bool	clippingEnabled () const
	Check if the view is currently being clipped to the clippingRect() property. More...

void	enableClipping (bool enabled)
	Enable or disable clipping of the view to the clippingRect() property. More...

const LRect &	clippingRect () const
	Get the current clipping rectangle defined by the clippingRect() property. More...

void	setClippingRect (const LRect &rect)
	Set the clipping rectangle for the view using the clippingRect() property. More...

bool	parentClippingEnabled () const
	Check if the view clipping to the current parent view rect is enabled. More...

void	enableParentClipping (bool enabled)
	Enable or disable clipping of the view to the current parent view rect. More...

bool	inputEnabled () const
	Check if the view receives pointer and touch events. More...

void	enableInput (bool enabled)
	Enable or disable pointer and touch events for the view. More...

bool	scalingEnabled () const
	Check if scaling is enabled for the view's size. More...

void	enableScaling (bool enabled)
	Enable or disable scaling for the view's size. More...

bool	parentScalingEnabled () const
	Check if the size and position are scaled by the parent scaling vector. More...

void	enableParentScaling (bool enabled)
	Enable or disable scaling of the size and position by the parent's scaling vector. More...

const LSizeF &	scalingVector (bool forceIgnoreParent=false) const
	Get the scaling vector for the view's size. More...

void	setScalingVector (const LSizeF &scalingVector)
	Set the scaling vector for the view's size. More...

bool	visible () const
	Check if the view is marked as visible. More...

void	setVisible (bool visible)
	Toggle the view visibility. More...

bool	mapped () const
	Check if the view should be rendered, taking into consideration several conditions. More...

Float32	opacity (bool forceIgnoreParent=false) const
	Get the current view opacity. More...

void	setOpacity (Float32 opacity)
	Set the view opacity. More...

bool	parentOpacityEnabled () const
	Check if the view's opacity is multiplied by its parent's opacity. More...

void	enableParentOpacity (bool enabled)
	Enable or disable the view's opacity being multiplied by its parent's opacity. More...

bool	forceRequestNextFrameEnabled () const
	Check if the requestNextFrame() is enabled. More...

void	enableForceRequestNextFrame (bool enabled) const
	Enable or disable the requestNextFrame() to be called always. More...

void	setBlendFunc (GLenum sRGBFactor, GLenum dRGBFactor, GLenum sAlphaFactor, GLenum dAlphaFactor)
	Set the alpha blending function for the view. More...

void	enableAutoBlendFunc (bool enabled)
	Enable or disable automatic blend function adjustment. More...

bool	autoBlendFuncEnabled () const
	Check whether the automatic blend function adjustment is enabled. More...

void	setColorFactor (Float32 r, Float32 g, Float32 b, Float32 a)
	Set the color factor. More...

const LRGBAF &	colorFactor ()
	Get the color factor. More...

bool	pointerIsOver () const
	Checks if the pointer/cursor is inside the view's input region. More...

void	enableBlockPointer (bool enabled)
	Enable or disable blocking of pointer or touch events to views behind the view's input region. More...

bool	blockPointerEnabled () const
	Checks if blocking of pointer or touch events to views behind the view's input region is enabled. More...

LBox	boundingBox () const
	Get the bounding box of the view and all its mapped children. More...

virtual void	pointerEnterEvent (const LPoint &localPos)
	Handle the pointer enter event within the view. More...

virtual void	pointerMoveEvent (const LPoint &localPos)
	Handle the pointer move event within the view. More...

virtual void	pointerLeaveEvent ()
	Handle the pointer leave event within the view. More...

virtual void	pointerButtonEvent (LPointer::Button button, LPointer::ButtonState state)
	Handle the pointer button event within the view. More...

virtual void	pointerAxisEvent (Float64 axisX, Float64 axisY, Int32 discreteX, Int32 discreteY, UInt32 source)
	Handle the pointer axis event within the view. More...

virtual void	keyModifiersEvent (UInt32 depressed, UInt32 latched, UInt32 locked, UInt32 group)
	Handle the key modifiers event within the view. More...

virtual void	keyEvent (UInt32 keyCode, UInt32 keyState)
	Handle the key event within the view. More...

Public Member Functions inherited from LObject
	LObject ()=default
	Constructor of the LObject class. More...

	~LObject ()
	Destructor of the LObject class. More...

std::shared_ptr< const bool >	isAlive () const
	Object's liveness status. More...

Additional Inherited Members
Public Types inherited from LView
enum	Type : UInt32
	Types of views included with Louvre. More...

Static Public Member Functions inherited from LObject
static LCompositor *	compositor ()
	Quick access to the global compositor instance. More...

static LSeat *	seat ()
	Quick access to the global seat instance. More...

static LCursor *	cursor ()
	Quick access to the global cursor instance. More...

Constructor & Destructor Documentation

◆ LSceneView()

LSceneView	(	const LSize &	sizeB,
		Float32	bufferScale,
		LView *	parent = `nullptr`
	)

Construct an LSceneView with a specified buffer size, buffer scale, and optional parent.

Parameters

sizeB	The size of the framebuffer for the scene view.
bufferScale	The scale factor applied to the framebuffer.
parent	The parent view that will contain this scene view.

◆ ~LSceneView()

~LSceneView ( )

Destructor for the LSceneView.

Member Function Documentation

◆ clearColor()

const LRGBAF & clearColor ( ) const

Retrieve the clear color of the scene view.

Returns: The clear color in RGBA format.

◆ setClearColor() [1/2]

void setClearColor	(	Float32	r,
		Float32	g,
		Float32	b,
		Float32	a
	)

Set the clear color of the scene view using individual RGBA components.

Parameters

r	The red color component (0.0 to 1.0).
g	The green color component (0.0 to 1.0).
b	The blue color component (0.0 to 1.0).
a	The alpha value (0.0 to 1.0).

◆ setClearColor() [2/2]

void setClearColor ( const LRGBAF & color )

Set the clear color of the scene view using an LRGBAF color.

Parameters

color The clear color in LRGBAF format.

◆ damageAll()

void damageAll ( LOutput * output )

Apply damage to all areas of the scene view for a specific output.

Parameters

output The output for which to apply damage.

◆ addDamage()

void addDamage	(	LOutput *	output,
		const LRegion &	damage
	)

Add specific damage areas to the scene view for a specific output.

Parameters

output	The output for which to add damage areas.
damage	The damaged regions to be added.

◆ isLScene()

bool isLScene ( ) const

Check if the view is the main view of an LScene.

Returns: True if it is the maint view of an LScene, false otherwise.

◆ render()

void render ( const LRegion * exclude = nullptr )

virtual

Render the scene.

This method initiates rendering for the view, excluding specified regions if provided.

Note: The rendered content can be accessed as a texture using the texture() method.

Parameters

exclude Regions to be excluded from rendering.

◆ texture()

LTexture * texture ( Int32 index = 0 ) const

virtual

Retrieve the texture associated with the view.

This method returns the texture linked to the view at a specified index.
LSceneViews always have a single texture, with the exception of the main view of an LScene. The main view may possess multiple textures, depending on the current LOutput thread and hardware configuration.

Parameters

index The index of the texture to retrieve (default is 0).

Returns: A pointer to the texture associated with the view.

◆ setPos() [1/2]

void setPos ( const LPoint & pos )

Set the position of the scene.

Parameters

pos	The new position of the scene.

◆ setPos() [2/2]

void setPos	(	Int32	x,
		Int32	y
	)

Set the position of the scene using X and Y coordinates.

Parameters

x	The X-coordinate of the new position.
y	The Y-coordinate of the new position.

◆ setSizeB()

void setSizeB ( const LSize & size )

Set the size of the scene framebuffer.

Warning: Changing the framebuffer size will destroy the current framebuffer and create a new one. Therefore, this operation should not be performed frequently.

Note: Calling this method on the main view of an LScene is a no-op. Instead, use LOutput::setMode() to control the size of the output framebuffer.

Parameters

size	The new size of the framebuffer.

◆ setScale()

void setScale ( Float32 scale )

Set the scale factor for the scene framebuffer.

Parameters

scale The new scale factor to be applied.

◆ nativeMapped()

bool nativeMapped ( ) const

overridevirtual

Tells whether the view should be rendered.

Returns: true if the view should be rendered without considering visible(), otherwise false.

Implements LView.

◆ nativePos()

const LPoint & nativePos ( ) const

overridevirtual

Get the position of the view without any transformations applied.

Must return the position of the view in surface coordinates.

Returns: The position of the view as an LPoint object.

Implements LView.

◆ nativeSize()

const LSize & nativeSize ( ) const

overridevirtual

Get the size of the view without any transformations applied.

Must return the size of the view in surface coordinates.

Returns: The size of the view as an LSize object.

Implements LView.

◆ bufferScale()

Float32 bufferScale ( ) const

overridevirtual

Get the scale of the view buffer content.

This property is primarily used by views that contain a buffer like for example the LSceneView, LSurfaceView and LTextureView types.

Returns: The buffer scale as an Int32 value.

Implements LView.

◆ enteredOutput()

void enteredOutput ( LOutput * output )

overridevirtual

Indicate that the view is visible on the given output.

This method is invoked by a LScene when the view's rect intersects an output.

Parameters

output The LOutput where the view is visible.

Implements LView.

◆ leftOutput()

void leftOutput ( LOutput * output )

overridevirtual

Indicate that the view is no longer visible on the given output.

This method is invoked by a LScene when the view's rect no longer intersects an output.

Parameters

output The LOutput from which the view is no longer visible.

Implements LView.

◆ outputs()

const std::vector< LOutput * > & outputs ( ) const

overridevirtual

Get a vector of output pointers on which the view is currently visible.

Must return a vector of output pointers where the view is currently visible. Use the enteredOutput() and leftOutput() methods to update the vector.

Returns: A reference to a vector of LOutput pointers representing the outputs where the view is visible.

Implements LView.

◆ isRenderable()

bool isRenderable ( ) const

overridevirtual

Check if the view is itself renderable.

This property indicates whether the view is capable of rendering its content (check paintEvent()). For example, all view types included in Louvre are renderable, except for LLayerView, which serves as a container for other views but does not produce any output by itself.

Returns: true if the view is renderable; otherwise, false.

Implements LView.

◆ requestNextFrame()

void requestNextFrame ( LOutput * output )

overridevirtual

Notify that the view has been rendered on the given output.

This method is called by LScene and should be used to clear the previous view damage or update its content. If forceRequestNextFrameEnabled() is true, this method is always called.

Parameters

output The LOutput on which the view is rendered.

Implements LView.

◆ damage()

const LRegion * damage ( ) const

overridevirtual

Get the region within the view rect that needs to be repainted.

The region rects are specified in surface coordinates within the view, without any scaling, clipping, or offset transformations applied. The damage may be cleared after requestNextFrame() is called. If nullptr is returned, the entire view rect will be considered damaged. If the view has no damage, simply pass an empty LRegion (not nullptr).

Returns: A pointer to the LRegion specifying the damaged area within the view, or nullptr if the entire view rect is damaged.

Implements LView.

◆ translucentRegion()

const LRegion * translucentRegion ( ) const

overridevirtual

Returns the translucent region within the view rectangle.

The region rects are specified in surface coordinates within the view, without any scaling, clipping, or offset transformations.
If nullptr is returned, the entire view rect will be considered translucent.

Implements LView.

◆ opaqueRegion()

const LRegion * opaqueRegion ( ) const

overridevirtual

Returns the opaque region within the view rectangle.

The region rects are specified in surface coordinates within the view, without any scaling, clipping, or offset transformations.
If nullptr is returned, the inverse of the translucent region will be considered opaque.

Implements LView.

◆ inputRegion()

const LRegion * inputRegion ( ) const

overridevirtual

Region within the view rect that can receive input events (when the inputEnabled() property is enabled).

The region rects are specified in surface coordinates within the view, without any scaling, clipping, or offset transformations.
If nullptr is returned, the entire view rect will receive input.

Implements LView.

◆ paintEvent()

void paintEvent ( const PaintEventParams & params )

overridevirtual

Request to paint a region of the view to the current framebuffer.

This method is used by LSceneView to request the view to paint a specified region on the current framebuffer. The painting is performed using the provided LPainter object.

Note: Alternatively, you have the option to use your own custom OpenGL shaders/program for rendering, in place of the provided LPainter.

Implements LView.

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ LSceneView()

◆ ~LSceneView()

Member Function Documentation

◆ clearColor()

◆ setClearColor() [1/2]

◆ setClearColor() [2/2]

◆ damageAll()

◆ addDamage()

◆ isLScene()

◆ render()

◆ texture()

◆ setPos() [1/2]

◆ setPos() [2/2]

◆ setSizeB()

◆ setScale()

◆ nativeMapped()

◆ nativePos()

◆ nativeSize()

◆ bufferScale()

◆ enteredOutput()

◆ leftOutput()

◆ outputs()

◆ isRenderable()

◆ requestNextFrame()

◆ damage()

◆ translucentRegion()

◆ opaqueRegion()

◆ inputRegion()

◆ paintEvent()