Louvre  v2.3.2-1
C++ library for Wayland compositors
Public Member Functions | List of all members
LSolidColorView Class Reference

View for displaying solid color rects. More...

+ Inheritance diagram for LSolidColorView:

Public Member Functions

 LSolidColorView (LView *parent=nullptr) noexcept
 Construct a solid color view as a child of another view. More...
 
 LSolidColorView (Float32 r=0.f, Float32 g=0.f, Float32 b=0.f, Float32 a=1.f, LView *parent=nullptr) noexcept
 Construct a solid color view with the specified color components and alpha. More...
 
 LSolidColorView (const LRGBF &color, Float32 a=1.f, LView *parent=nullptr) noexcept
 Construct a solid color view with the specified color and alpha. More...
 
 ~LSolidColorView () noexcept=default
 Destructor for the solid color view. More...
 
void setColor (const LRGBF &color) noexcept
 Set the color of the solid color view. More...
 
const LRGBFcolor () const noexcept
 Gets the current color of the solid color view. More...
 
void setPos (const LPoint &pos) noexcept
 Set the position of the solid color view. More...
 
void setPos (Int32 x, Int32 y) noexcept
 Set the position of the solid color view using individual X and Y coordinates. More...
 
void setSize (const LSize &size) noexcept
 Set the size of the solid color view. More...
 
void setSize (Int32 w, Int32 h) noexcept
 Set the size of the solid color view using width and height values. More...
 
void setInputRegion (const LRegion *region) noexcept
 Set the input region for the solid color view. More...
 
virtual bool nativeMapped () const noexcept override
 Tells whether the view should be rendered. More...
 
virtual const LPointnativePos () const noexcept override
 Gets the position of the view without any transformations applied. More...
 
virtual const LSizenativeSize () 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 LRegiondamage () const noexcept override
 Gets the region within the view rect that needs to be repainted. More...
 
virtual const LRegiontranslucentRegion () const noexcept override
 Gets the current translucent region. More...
 
virtual const LRegionopaqueRegion () const noexcept override
 Gets the current opaque region. More...
 
virtual const LRegioninputRegion () const noexcept override
 Gets the current input region. More...
 
virtual void paintEvent (const PaintEventParams &params) 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...
 
LScenescene () 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...
 
LSceneViewparentSceneView () 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...
 
LViewparent () 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 LPointpos () const noexcept
 Gets the current position of the view with applied transformations. More...
 
const LSizesize () 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 LRectclippingRect () 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 LSizeFscalingVector (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 LBlendFuncblendFunc () 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 LRGBAFcolorFactor () 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...
 
LObjectoperator= (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...
 

Detailed Description

View for displaying solid color rects.

This class provides functionality to display solid color rectangles within a scene.

Constructor & Destructor Documentation

◆ LSolidColorView() [1/3]

LSolidColorView ( LView parent = nullptr)
inlinenoexcept

Construct a solid color view as a child of another view.

Parameters
parentThe parent view that will contain this solid color view.

◆ LSolidColorView() [2/3]

LSolidColorView ( Float32  r = 0.f,
Float32  g = 0.f,
Float32  b = 0.f,
Float32  a = 1.f,
LView parent = nullptr 
)
inlinenoexcept

Construct a solid color view with the specified color components and alpha.

Parameters
rThe red color component (0.0 to 1.0).
gThe green color component (0.0 to 1.0).
bThe blue color component (0.0 to 1.0).
aThe alpha value (0.0 to 1.0).
parentThe parent view that will contain this solid color view.

◆ LSolidColorView() [3/3]

LSolidColorView ( const LRGBF color,
Float32  a = 1.f,
LView parent = nullptr 
)
inlinenoexcept

Construct a solid color view with the specified color and alpha.

Parameters
colorThe color in RGB format.
aThe alpha value (0.0 to 1.0).
parentThe parent view that will contain this solid color view.

◆ ~LSolidColorView()

~LSolidColorView ( )
defaultnoexcept

Destructor for the solid color view.

Member Function Documentation

◆ setColor()

void setColor ( const LRGBF color)
inlinenoexcept

Set the color of the solid color view.

Parameters
colorThe new color for the view in RGB format.

◆ color()

const LRGBF& color ( ) const
inlinenoexcept

Gets the current color of the solid color view.

Returns
The current color of the view in RGB format.

◆ setPos() [1/2]

void setPos ( const LPoint pos)
inlinenoexcept

Set the position of the solid color view.

Parameters
posThe new position of the view.

◆ setPos() [2/2]

void setPos ( Int32  x,
Int32  y 
)
inlinenoexcept

Set the position of the solid color view using individual X and Y coordinates.

Parameters
xThe X-coordinate of the new position.
yThe Y-coordinate of the new position.

◆ setSize() [1/2]

void setSize ( const LSize size)
inlinenoexcept

Set the size of the solid color view.

Parameters
sizeThe new size of the view.

◆ setSize() [2/2]

void setSize ( Int32  w,
Int32  h 
)
inlinenoexcept

Set the size of the solid color view using width and height values.

Parameters
wThe new width of the view.
hThe new height of the view.

◆ setInputRegion()

void setInputRegion ( const LRegion region)
inlinenoexcept

Set the input region for the solid color view.

Parameters
regionThe new input region for the view.

◆ nativeMapped()

bool nativeMapped ( ) const
overridevirtualnoexcept

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
overridevirtualnoexcept

Gets the position of the view without any transformations applied.

Must return the position of the view in compositor-global coordinates.

Returns
The position of the view as an LPoint object.

Implements LView.

◆ nativeSize()

const LSize & nativeSize ( ) const
overridevirtualnoexcept

Gets 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
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.

Returns
The buffer scale as an Int32 value.

Implements LView.

◆ enteredOutput()

void enteredOutput ( LOutput output)
overridevirtualnoexcept

Notifies that portion of the view is visible on the given output.

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

Parameters
outputThe LOutput where the view is visible.

Implements LView.

◆ leftOutput()

void leftOutput ( LOutput output)
overridevirtualnoexcept

Notifies 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
outputThe LOutput from which the view is no longer visible.

Implements LView.

◆ outputs()

const std::vector< LOutput * > & outputs ( ) const
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.

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

Implements LView.

◆ requestNextFrame()

void requestNextFrame ( LOutput output)
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.

Parameters
outputThe LOutput on which the view is rendered.

Implements LView.

◆ damage()

const LRegion * damage ( ) const
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).

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
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.

◆ opaqueRegion()

const LRegion * opaqueRegion ( ) const
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.

Note
You could only specify the translucent region.

Implements LView.

◆ inputRegion()

const LRegion * inputRegion ( ) const
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.

◆ paintEvent()

void paintEvent ( const PaintEventParams params)
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.

Note
Using LPainter is optional.

Implements LView.