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.
KZ_NO_DISCARD const IVISurfaceProps &	getProps () const noexcept
	Gets internal surface state.
KZ_NO_DISCARD uint32_t	getSurfaceId () const noexcept
	Gets surface ID.
KZ_NO_DISCARD bool	isCreated () const noexcept
	Gets m_isCreated value.
	IVIWMSurface (IVIWM &iviWM, const IVISurfaceProps &iviSurfaceProps) noexcept
	Constructor.
void	setCreated (bool value) noexcept
	Sets m_isCreated value.
void	setDestination (int32_t x, int32_t y, int32_t width, int32_t height) const noexcept
	Requests compositor to change destination rectangle.
void	setOpacity (double opacity) const noexcept
	Requests compositor to change opacity.
void	setProps (const IVISurfaceProps &props) noexcept
	Sets internal surface state.
void	setSource (int32_t x, int32_t y, int32_t width, int32_t height) const noexcept
	Requests compositor to change source rectangle.
void	setType (ivi_wm_surface_type type) const noexcept
	Requests compositor to change surface type.
void	setVisibility (uint32_t visibility) const noexcept
	Requests compositor to change visibility.
void	syncStart () const noexcept
	Request compositor to start sending event about surface changes.
void	syncStop () const noexcept
	Request compositor to stop sending event about surface changes.

Detailed Description

Represents IVI surface from WM point of view.

Since

Kanzi 3.9.8

Constructor & Destructor Documentation

IVIWMSurface()

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

explicitnoexcept

Constructor.

Parameters

iviWM	IVIWM object.
iviSurfaceProps	Surface properties to use for this surface.

Member Function Documentation

setType()

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

noexcept

Requests compositor to change surface type.

Parameters

type	Surface type to set.

setVisibility()

void kanzi::wayland::IVIWMSurface::setVisibility ( uint32_t visibility ) const

noexcept

Requests compositor to change visibility.

Parameters

visibility

Visibility to set.

setSource()

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

x	X coordinate.
y	Y coordinate.
width	Width.
height	Height.

setDestination()

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

x	X coordinate.
y	Y coordinate.
width	Width.
height	Height.

setOpacity()

void kanzi::wayland::IVIWMSurface::setOpacity ( double opacity ) const

noexcept

Requests compositor to change opacity.

Parameters

opacity

Opacity value.

configure()

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

surfaceProps

Properties to use.

syncStart()

void kanzi::wayland::IVIWMSurface::syncStart ( ) const

noexcept

Request compositor to start sending event about surface changes.

See also

syncStop()

syncStop()

void kanzi::wayland::IVIWMSurface::syncStop ( ) const

noexcept

Request compositor to stop sending event about surface changes.

See also

syncStart()

isCreated()

KZ_NO_DISCARD bool kanzi::wayland::IVIWMSurface::isCreated ( ) const

noexcept

Gets m_isCreated value.

Return values

true	Surface was created.
false	Surface was not created.

setCreated()

void kanzi::wayland::IVIWMSurface::setCreated ( bool value )

noexcept

Sets m_isCreated value.

Parameters

value

Value to set.

getSurfaceId()

KZ_NO_DISCARD uint32_t kanzi::wayland::IVIWMSurface::getSurfaceId ( ) const

noexcept

Gets surface ID.

Returns

Surface ID.

getProps()

KZ_NO_DISCARD const IVISurfaceProps & kanzi::wayland::IVIWMSurface::getProps ( ) const

noexcept

Gets internal surface state.

Returns

Internal surface state.

setProps()

void kanzi::wayland::IVIWMSurface::setProps ( const IVISurfaceProps & props )

noexcept

Sets internal surface state.

Parameters

props

Properties to use.

---

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

• kanzi/core.ui/platform/windowing_ng/wayland_ivi_egl/wayland_ivi_wm_surface.hpp