Louvre
v2.9.0-1
C++ library for Wayland compositors
|
View for rendering other views. More...
Public Member Functions | |
LSceneView (const LSize &sizeB, Float32 bufferScale, LView *parent=nullptr) noexcept | |
Construct an LSceneView with a specified buffer size, buffer scale, and optional parent. More... | |
~LSceneView () noexcept | |
Destructor for the LSceneView. More... | |
const LRGBAF & | clearColor () const noexcept |
Retrieve the clear color of the scene view. More... | |
void | setClearColor (const LRGBAF &color) noexcept |
Set the clear color of the scene view using an LRGBAF color. More... | |
void | damageAll (LOutput *output) noexcept |
Apply damage to all areas of the scene view for a specific output. More... | |
void | addDamage (LOutput *output, const LRegion &damage) noexcept |
Add specific damage areas to the scene view for a specific output. More... | |
void | render (const LRegion *exclude=nullptr) noexcept |
Render the scene. More... | |
LTexture * | texture (Int32 index=0) const noexcept |
Retrieve the texture associated with the view. More... | |
void | setPos (const LPoint &pos) noexcept |
Set the position of the scene. More... | |
void | setPos (Int32 x, Int32 y) noexcept |
Set the position of the scene using X and Y coordinates. More... | |
void | setSizeB (const LSize &size) noexcept |
Set the size of the scene framebuffer. More... | |
void | setScale (Float32 scale) noexcept |
Set the scale factor for the scene framebuffer. More... | |
virtual bool | nativeMapped () const noexcept override |
Tells whether the view should be rendered. More... | |
virtual const LPoint & | nativePos () const noexcept override |
Gets the position of the view without any transformations applied. More... | |
virtual const LSize & | nativeSize () const noexcept override |
Gets the size of the view without any transformations applied. More... | |
virtual Float32 | bufferScale () const noexcept override |
Gets the scale of the view buffer content. More... | |
virtual void | enteredOutput (LOutput *output) noexcept override |
Notifies that portion of the view is visible on the given output. More... | |
virtual void | leftOutput (LOutput *output) noexcept override |
Notifies that the view is no longer visible on the given output. More... | |
virtual const std::vector< LOutput * > & | outputs () const noexcept override |
Gets a vector of output pointers on which the view is currently visible. More... | |
virtual void | requestNextFrame (LOutput *output) noexcept override |
Notifies that the view has been rendered on the given output. More... | |
virtual const LRegion * | damage () const noexcept override |
Gets the region within the view rect that needs to be repainted. More... | |
virtual const LRegion * | translucentRegion () const noexcept override |
Gets the current translucent region. More... | |
virtual const LRegion * | opaqueRegion () const noexcept override |
Gets the current opaque region. More... | |
virtual const LRegion * | inputRegion () const noexcept override |
Gets the current input region. More... | |
virtual void | paintEvent (const PaintEventParams ¶ms) noexcept override |
Requests to paint a region of the view to the current framebuffer. More... | |
Public Member Functions inherited from LView | |
LView (UInt32 type, bool renderable, LView *parent) noexcept | |
Construct an LView object. More... | |
~LView () noexcept | |
Destructor for the LView class. More... | |
void | enablePointerEvents (bool enabled) noexcept |
Toggles pointer events. More... | |
bool | pointerEventsEnabled () const noexcept |
Checks if pointer events are enabled. More... | |
bool | pointerIsOver () const noexcept |
Checks if the view has pointer focus. More... | |
void | enableBlockPointer (bool enabled) noexcept |
Toggles blocking pointer events to views behind the view's input region. More... | |
bool | blockPointerEnabled () const noexcept |
Checks if blocking of pointer events is enabled. More... | |
void | enableKeyboardEvents (bool enabled) noexcept |
Toggles keyboard events. More... | |
bool | keyboardEventsEnabled () const noexcept |
Checks if keyboard events are enabled. More... | |
void | enableTouchEvents (bool enabled) noexcept |
Toggles touch events. More... | |
bool | touchEventsEnabled () const noexcept |
Checks if touch events are enabled. More... | |
void | enableBlockTouch (bool enabled) noexcept |
Toggles blocking touch events to views behind the view's input region. More... | |
bool | blockTouchEnabled () const noexcept |
Checks if blocking of touch events to views behind the view's input region is enabled. More... | |
void | damageAll () noexcept |
Forces a complete repaint of the view in the next rendering frame. More... | |
LScene * | scene () const noexcept |
Gets the scene in which this view is currently embedded. More... | |
bool | isLScene () const noexcept |
Checks if the view is an LScene::mainView(). More... | |
LSceneView * | parentSceneView () const noexcept |
Gets the closest parent LSceneView. More... | |
UInt32 | type () const noexcept |
Gets the identifier for the type of view. More... | |
bool | isRenderable () const noexcept |
Checks if the view is renderable. More... | |
void | repaint () const noexcept |
Schedules a repaint for all outputs where this view is currently visible. More... | |
LView * | parent () const noexcept |
Gets the parent of the view. More... | |
void | setParent (LView *view) noexcept |
Sets the new parent for the view and insert it at the end of its children list. More... | |
void | insertAfter (LView *prev) noexcept |
Inserts the view after the specified 'prev' view. More... | |
const std::list< LView * > & | children () const noexcept |
Children views. More... | |
void | enableParentOffset (bool enabled) noexcept |
Toggles the parent position offset. More... | |
bool | parentOffsetEnabled () const noexcept |
Checks if pos() includes the parent's position. More... | |
const LPoint & | pos () const noexcept |
Gets the current position of the view with applied transformations. More... | |
const LSize & | size () const noexcept |
Gets the current size of the view with applied transformations. More... | |
void | enableClipping (bool enabled) noexcept |
Toggles the use of the clippingRect() property. More... | |
bool | clippingEnabled () const noexcept |
Checks if the view is currently being clipped to the clippingRect() property. More... | |
void | setClippingRect (const LRect &rect) noexcept |
Sets a custom clipping rect. More... | |
const LRect & | clippingRect () const noexcept |
Gets the clipping rect set with setClippingRect(). More... | |
void | enableParentClipping (bool enabled) noexcept |
Toggles parent clipping. More... | |
bool | parentClippingEnabled () const noexcept |
Checks if the view is clipped to the parent view rect. More... | |
void | enableScaling (bool enabled) noexcept |
Toggles the use of the scalingVector(). More... | |
bool | scalingEnabled () const noexcept |
Checks if the scalingVector() is enabled. More... | |
void | setScalingVector (const LSizeF &scalingVector) noexcept |
Sets the scalingVector() property. More... | |
const LSizeF & | scalingVector (bool forceIgnoreParent=false) const noexcept |
Gets the scaling vector. More... | |
void | enableParentScaling (bool enabled) noexcept |
Toggles the scaling of size and position by the parent's scaling vector. More... | |
bool | parentScalingEnabled () const noexcept |
Checks if the size and position are scaled by the parent's scalingVector(). More... | |
void | setVisible (bool visible) noexcept |
Toggles the view visibility. More... | |
bool | visible () const noexcept |
Checks if the view is marked as visible. More... | |
bool | mapped () const noexcept |
Checks if the view should be rendered, taking into consideration several conditions. More... | |
void | setOpacity (Float32 opacity) noexcept |
Set the view opacity. More... | |
Float32 | opacity (bool forceIgnoreParent=false) const noexcept |
Gets the view opacity. More... | |
void | enableParentOpacity (bool enabled) noexcept |
Toggles the use of the parent's opacity. More... | |
bool | parentOpacityEnabled () const noexcept |
Checks if the view's opacity is multiplied by its parent's opacity. More... | |
void | enableForceRequestNextFrame (bool enabled) noexcept |
Toggles forcing triggering the requestNextFrame() event. More... | |
bool | forceRequestNextFrameEnabled () const noexcept |
Checks if forcing requestNextFrame() is enabled. More... | |
void | setBlendFunc (const LBlendFunc &blendFunc) noexcept |
Sets a custom alpha/color blending function for the view. More... | |
const LBlendFunc & | blendFunc () const noexcept |
Gets the blending function set with setBlendFunc(). More... | |
void | enableAutoBlendFunc (bool enabled) noexcept |
Toggles the automatic blend function adjustment. More... | |
bool | autoBlendFuncEnabled () const noexcept |
Checks whether the automatic blend function adjustment is enabled. More... | |
void | setColorFactor (const LRGBAF &colorFactor) noexcept |
Set the color factor. More... | |
const LRGBAF & | colorFactor () const noexcept |
Gets the color factor. More... | |
LBox | boundingBox () const noexcept |
Gets the bounding box of the view and all its mapped children. More... | |
virtual void | pointerEnterEvent (const LPointerEnterEvent &event) |
Handles a pointer enter event within the view. More... | |
virtual void | pointerMoveEvent (const LPointerMoveEvent &event) |
Handle a pointer move event within the view. More... | |
virtual void | pointerLeaveEvent (const LPointerLeaveEvent &event) |
Handle a pointer leave event within the view. More... | |
virtual void | pointerButtonEvent (const LPointerButtonEvent &event) |
Handle a pointer button event within the view. More... | |
virtual void | pointerScrollEvent (const LPointerScrollEvent &event) |
Handle a pointer scroll event within the view. More... | |
virtual void | pointerSwipeBeginEvent (const LPointerSwipeBeginEvent &event) |
Handle a pointer swipe begin event within the view. More... | |
virtual void | pointerSwipeUpdateEvent (const LPointerSwipeUpdateEvent &event) |
Handle a pointer swipe update event within the view. More... | |
virtual void | pointerSwipeEndEvent (const LPointerSwipeEndEvent &event) |
Handle a pointer swipe end event within the view. More... | |
virtual void | pointerPinchBeginEvent (const LPointerPinchBeginEvent &event) |
Handle a pointer pinch begin event within the view. More... | |
virtual void | pointerPinchUpdateEvent (const LPointerPinchUpdateEvent &event) |
Handle a pointer pinch update event within the view. More... | |
virtual void | pointerPinchEndEvent (const LPointerPinchEndEvent &event) |
Handle a pointer pinch end event within the view. More... | |
virtual void | pointerHoldBeginEvent (const LPointerHoldBeginEvent &event) |
Handle a pointer hold begin event within the view. More... | |
virtual void | pointerHoldEndEvent (const LPointerHoldEndEvent &event) |
Handle a pointer hold end event within the view. More... | |
virtual void | keyEvent (const LKeyboardKeyEvent &event) |
Handle the key event within the view. More... | |
virtual void | touchDownEvent (const LTouchDownEvent &event) |
Handle a touch down event within the view. More... | |
virtual void | touchMoveEvent (const LTouchMoveEvent &event) |
Handle a touch move event within the view. More... | |
virtual void | touchUpEvent (const LTouchUpEvent &event) |
Handle a touch up event within the view. More... | |
virtual void | touchFrameEvent (const LTouchFrameEvent &event) |
Handle a touch frame event within the view. More... | |
virtual void | touchCancelEvent (const LTouchCancelEvent &event) |
Handle a touch cancel event within the view. More... | |
Public Member Functions inherited from LObject | |
LObject (const LObject &) noexcept | |
Copy constructor. More... | |
LObject & | operator= (const LObject &) noexcept |
Assignment operator (each object has its own individual LWeak reference count). More... | |
void | setUserData (UIntPtr data) const noexcept |
Store an unsigned integer value/pointer. More... | |
UIntPtr | userData () const noexcept |
Retrieves the stored unsigned integer value/pointer. More... | |
Additional Inherited Members | |
Public Types inherited from LView | |
enum | Type : UInt8 |
Types of views included with Louvre. More... | |
Protected Member Functions inherited from LObject | |
LObject () noexcept=default | |
Constructor of the LObject class. More... | |
virtual | ~LObject () noexcept |
Destructor of the LObject class. More... | |
void | notifyDestruction () noexcept |
Notifies the object destruction. More... | |
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 with other views, child views of an LSceneView are always clipped to its boundaries.
LSceneViews can function as children of other views or LSceneViews (just like any other view), but they can also be used independently.
For example, you might create an LSceneView, populate it with arranged views, execute the render() function, and then use the 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.
|
inlinenoexcept |
Construct an LSceneView with a specified buffer size, buffer scale, and optional parent.
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. |
|
noexcept |
Destructor for the LSceneView.
|
inlinenoexcept |
Retrieve the clear color of the scene view.
|
inlinenoexcept |
|
noexcept |
Apply damage to all areas of the scene view for a specific output.
output | The output for which to apply damage. |
Add specific damage areas to the scene view for a specific output.
output | The output for which to add damage areas. |
damage | The damaged regions to be added. |
|
noexcept |
Render the scene.
This method initiates rendering for the view, excluding specified regions if provided.
exclude | Regions to be excluded from rendering. |
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.
index | The index of the texture to retrieve (default is 0). |
|
inlinenoexcept |
Set the position of the scene.
pos | The new position of the scene. |
Set the position of the scene using X and Y coordinates.
x | The X-coordinate of the new position. |
y | The Y-coordinate of the new position. |
|
inlinenoexcept |
Set the size of the scene framebuffer.
size | The new size of the framebuffer. |
|
inlinenoexcept |
Set the scale factor for the scene framebuffer.
scale | The new scale factor to be applied. |
|
overridevirtualnoexcept |
|
overridevirtualnoexcept |
Gets the position of the view without any transformations applied.
Must return the position of the view in compositor-global coordinates.
Implements LView.
|
overridevirtualnoexcept |
Gets the size of the view without any transformations applied.
Must return the size of the view in surface coordinates.
Implements LView.
|
overridevirtualnoexcept |
Gets 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.
Implements LView.
|
overridevirtualnoexcept |
|
overridevirtualnoexcept |
|
overridevirtualnoexcept |
Gets 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.
Implements LView.
|
overridevirtualnoexcept |
Notifies that the view has been rendered on the given output.
This method is called by the closest parent scene view and should be used to clear the previous view damage or update its content.
If forceRequestNextFrameEnabled() is true
, this method is always called.
output | The LOutput on which the view is rendered. |
Implements LView.
|
overridevirtualnoexcept |
Gets 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.
It should 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
).
nullptr
if the entire view rect is damaged. Implements LView.
|
overridevirtualnoexcept |
Gets the current translucent region.
The region must be specified in surface-local coordinates, without any scaling, clipping, or offset transformations applied.
If nullptr
is returned, the entire view rect will be considered translucent.
Implements LView.
|
overridevirtualnoexcept |
Gets the current opaque region.
The region must be specified in surface-local coordinates without any scaling, clipping, or offset transformations applied.
If nullptr
is returned, the inverse of the translucent region will be considered opaque.
Implements LView.
|
overridevirtualnoexcept |
Gets the current input region.
Region within the view rect that can receive pointer and touch events.
The region must be specified in surface-local coordinates without any scaling, clipping, or offset transformations applied.
If nullptr
is returned, the entire view will receive input.
Implements LView.
|
overridevirtualnoexcept |
Requests to paint a region of the view to the current framebuffer.
This method is used by the closest parent LSceneView to request the view to paint a specified region on the current framebuffer. Painting can be performed using the provided LPainter object.
Implements LView.