Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::wayland::IVIWMSurface Class Reference

Represents IVI surface from WM point of view. More...

#include <kanzi/core.ui/platform/windowing_ng/wayland_ivi_egl/wayland_ivi_wm_surface.hpp>

Public Member Functions

void configure (const IVISurfaceProps &surfaceProps) const noexcept
 Helper function that will request compositor to change surface state to match supplied properties. More...
 
KZ_NO_DISCARD const IVISurfacePropsgetProps () const noexcept
 Gets internal surface state. More...
 
KZ_NO_DISCARD uint32_t getSurfaceId () const noexcept
 Gets surface ID. More...
 
KZ_NO_DISCARD bool isCreated () const noexcept
 Gets m_isCreated value. More...
 
 IVIWMSurface (IVIWM &iviWM, const IVISurfaceProps &iviSurfaceProps) noexcept
 Constructor. More...
 
void setCreated (bool value) noexcept
 Sets m_isCreated value. More...
 
void setDestination (int32_t x, int32_t y, int32_t width, int32_t height) const noexcept
 Requests compositor to change destination rectangle. More...
 
void setOpacity (double opacity) const noexcept
 Requests compositor to change opacity. More...
 
void setProps (const IVISurfaceProps &props) noexcept
 Sets internal surface state. More...
 
void setSource (int32_t x, int32_t y, int32_t width, int32_t height) const noexcept
 Requests compositor to change source rectangle. More...
 
void setType (ivi_wm_surface_type type) const noexcept
 Requests compositor to change surface type. More...
 
void setVisibility (uint32_t visibility) const noexcept
 Requests compositor to change visibility. More...
 
void syncStart () const noexcept
 Request compositor to start sending event about surface changes. More...
 
void syncStop () const noexcept
 Request compositor to stop sending event about surface changes. More...
 

Detailed Description

Represents IVI surface from WM point of view.

Since
Kanzi 3.9.8

Constructor & Destructor Documentation

kanzi::wayland::IVIWMSurface::IVIWMSurface ( IVIWM iviWM,
const IVISurfaceProps iviSurfaceProps 
)
explicitnoexcept

Constructor.

Parameters
iviWMIVIWM object.
iviSurfacePropsSurface properties to use for this surface.

Member Function Documentation

void kanzi::wayland::IVIWMSurface::setType ( ivi_wm_surface_type  type) const
noexcept

Requests compositor to change surface type.

Parameters
typeSurface type to set.
void kanzi::wayland::IVIWMSurface::setVisibility ( uint32_t  visibility) const
noexcept

Requests compositor to change visibility.

Parameters
visibilityVisibility to set.
void kanzi::wayland::IVIWMSurface::setSource ( int32_t  x,
int32_t  y,
int32_t  width,
int32_t  height 
) const
noexcept

Requests compositor to change source rectangle.

Parameters
xX coordinate.
yY coordinate.
widthWidth.
heightHeight.
void kanzi::wayland::IVIWMSurface::setDestination ( int32_t  x,
int32_t  y,
int32_t  width,
int32_t  height 
) const
noexcept

Requests compositor to change destination rectangle.

Parameters
xX coordinate.
yY coordinate.
widthWidth.
heightHeight.
void kanzi::wayland::IVIWMSurface::setOpacity ( double  opacity) const
noexcept

Requests compositor to change opacity.

Parameters
opacityOpacity value.
void kanzi::wayland::IVIWMSurface::configure ( const IVISurfaceProps surfaceProps) const
noexcept

Helper function that will request compositor to change surface state to match supplied properties.

Parameters
surfacePropsProperties to use.
void kanzi::wayland::IVIWMSurface::syncStart ( ) const
noexcept

Request compositor to start sending event about surface changes.

See also
syncStop()
void kanzi::wayland::IVIWMSurface::syncStop ( ) const
noexcept

Request compositor to stop sending event about surface changes.

See also
syncStart()
KZ_NO_DISCARD bool kanzi::wayland::IVIWMSurface::isCreated ( ) const
noexcept

Gets m_isCreated value.

Return values
trueSurface was created.
falseSurface was not created.
void kanzi::wayland::IVIWMSurface::setCreated ( bool  value)
noexcept

Sets m_isCreated value.

Parameters
valueValue to set.
KZ_NO_DISCARD uint32_t kanzi::wayland::IVIWMSurface::getSurfaceId ( ) const
noexcept

Gets surface ID.

Returns
Surface ID.
KZ_NO_DISCARD const IVISurfaceProps& kanzi::wayland::IVIWMSurface::getProps ( ) const
noexcept

Gets internal surface state.

Returns
Internal surface state.
void kanzi::wayland::IVIWMSurface::setProps ( const IVISurfaceProps props)
noexcept

Sets internal surface state.

Parameters
propsProperties to use.

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