cDrmPlane Class Reference

DRM Plane. More...

#include <drmplane.h>

Public Member Functions
	cDrmPlane (void)=default
void	SetParams (uint64_t, uint64_t, uint64_t, uint64_t, uint64_t, uint64_t, uint64_t, uint64_t, uint64_t, uint64_t)
	Caches the modesetting parameters of a plane.
void	DumpParameters (const char *)
	Dump the cached plane parameter modesetting values.
void	FillProperties (int)
	Fill the plane properties.
void	FreeProperties (void)
	Free the previously filled plane properties.
void	SetPlaneZpos (drmModeAtomicReqPtr)
	Set the plane zpos property.
void	SetPlane (drmModeAtomicReqPtr)
	Set all plane properties (except zpos)
void	ClearPlane (drmModeAtomicReqPtr)
	Clear plane from drm.
int	HasZpos (int)
	Check, if the plane is able to set the zpos property.
uint32_t	GetId (void)
void	SetId (uint32_t id)
uint64_t	GetType (void)
void	SetType (uint64_t type)
uint64_t	GetCrtcId (void)
uint64_t	GetFbId (void)
uint64_t	GetCrtcX (void)
uint64_t	GetCrtcY (void)
uint64_t	GetCrtcW (void)
uint64_t	GetCrtcH (void)
uint64_t	GetSrcX (void)
uint64_t	GetSrcY (void)
uint64_t	GetSrcW (void)
uint64_t	GetSrcH (void)
uint64_t	GetZpos (void)
void	SetZpos (uint64_t zpos)
int	GetCountProps (void)
char *	GetPropsInfoName (int prop)
uint32_t	GetPropsInfoPropId (int prop)
drmModeObjectProperties *	GetProps (void)
void	SetProps (drmModeObjectProperties *props)
drmModePropertyRes **	GetPropsInfo (void)
drmModePropertyRes **	GetPropsInfoElem (int elem)

Private Member Functions
int	SetPropertyRequest (drmModeAtomicReqPtr, const char *, uint64_t)
	Add the properties to the mode setting request.

Private Attributes
uint32_t	m_planeId = 0
	the plane's ID
uint64_t	m_type = 0
	type: DRM_PLANE_TYPE_PRIMARY or DRM_PLANE_TYPE_OVERLAY
drmModeObjectProperties *	m_props = nullptr
drmModePropertyRes **	m_propsInfo
uint64_t	m_crtcId
	CRTC_ID.
uint64_t	m_fbId
	FB_ID.
uint64_t	m_crtcX
	CRTC_X.
uint64_t	m_crtcY
	CRTC_Y.
uint64_t	m_crtcW
	CRTC_W.
uint64_t	m_crtcH
	CRTC_H.
uint64_t	m_srcX
	SRC_X.
uint64_t	m_srcY
	SRC_Y.
uint64_t	m_srcW
	SRC_W.
uint64_t	m_srcH
	SRC_H.
uint64_t	m_zpos = 0
	ZPOS.

Detailed Description

DRM Plane.

Definition at line 23 of file drmplane.h.

Constructor & Destructor Documentation

cDrmPlane()

cDrmPlane::cDrmPlane ( void  )

default

Member Function Documentation

ClearPlane()

void cDrmPlane::ClearPlane

(

drmModeAtomicReqPtr

ModeReq

)

Clear plane from drm.

Parameters

ModeReq

pointer to the atomic mode request

Definition at line 165 of file drmplane.cpp.

References SetPropertyRequest().

DumpParameters()

void cDrmPlane::DumpParameters

(

const char *

id

)

Dump the cached plane parameter modesetting values.

Definition at line 206 of file drmplane.cpp.

References GetCrtcH(), GetCrtcId(), GetCrtcW(), GetCrtcX(), GetCrtcY(), GetFbId(), GetId(), GetSrcH(), GetSrcW(), GetSrcX(), GetSrcY(), GetZpos(), and LOGERROR.

FillProperties()

void cDrmPlane::FillProperties

(

int

fd

)

Fill the plane properties.

This "caches" the properties within the class

Parameters

fd	drm file descriptor

Definition at line 34 of file drmplane.cpp.

References GetId(), LOGERROR, m_props, m_propsInfo, and SetProps().

Referenced by cDrmDevice::Init().

FreeProperties()

void cDrmPlane::FreeProperties

(

void

)

Free the previously filled plane properties.

Definition at line 53 of file drmplane.cpp.

References GetProps(), GetPropsInfo(), m_props, and m_propsInfo.

GetCountProps()

int cDrmPlane::GetCountProps ( void  )

inline

Definition at line 56 of file drmplane.h.

References m_props.

Referenced by SetPropertyRequest().

GetCrtcH()

uint64_t cDrmPlane::GetCrtcH ( void  )

inline

Definition at line 48 of file drmplane.h.

References m_crtcH.

Referenced by DumpParameters(), and SetPlane().

GetCrtcId()

uint64_t cDrmPlane::GetCrtcId ( void  )

inline

Definition at line 43 of file drmplane.h.

References m_crtcId.

Referenced by DumpParameters(), and SetPlane().

GetCrtcW()

uint64_t cDrmPlane::GetCrtcW ( void  )

inline

Definition at line 47 of file drmplane.h.

References m_crtcW.

Referenced by DumpParameters(), and SetPlane().

GetCrtcX()

uint64_t cDrmPlane::GetCrtcX ( void  )

inline

Definition at line 45 of file drmplane.h.

References m_crtcX.

Referenced by DumpParameters(), and SetPlane().

GetCrtcY()

uint64_t cDrmPlane::GetCrtcY ( void  )

inline

Definition at line 46 of file drmplane.h.

References m_crtcY.

Referenced by DumpParameters(), and SetPlane().

GetFbId()

uint64_t cDrmPlane::GetFbId ( void  )

inline

Definition at line 44 of file drmplane.h.

References m_fbId.

Referenced by DumpParameters(), and SetPlane().

GetId()

uint32_t cDrmPlane::GetId ( void  )

inline

Definition at line 39 of file drmplane.h.

References m_planeId.

Referenced by DumpParameters(), FillProperties(), cDrmDevice::GetVideoPlaneColorRange(), cDrmDevice::HasPipPlane(), cDrmDevice::Init(), cVideoRender::SetColorSpace(), SetPropertyRequest(), cDrmDevice::SetVideoPlaneColorEncoding(), and cDrmDevice::SetVideoPlaneColorRange().

GetProps()

drmModeObjectProperties * cDrmPlane::GetProps ( void  )

inline

Definition at line 59 of file drmplane.h.

References m_props.

Referenced by FreeProperties().

GetPropsInfo()

drmModePropertyRes ** cDrmPlane::GetPropsInfo ( void  )

inline

Definition at line 61 of file drmplane.h.

References m_propsInfo.

Referenced by FreeProperties().

GetPropsInfoElem()

drmModePropertyRes ** cDrmPlane::GetPropsInfoElem ( int  elem )

inline

Definition at line 62 of file drmplane.h.

References m_propsInfo.

GetPropsInfoName()

char * cDrmPlane::GetPropsInfoName ( int  prop )

inline

Definition at line 57 of file drmplane.h.

References m_propsInfo.

Referenced by SetPropertyRequest().

GetPropsInfoPropId()

uint32_t cDrmPlane::GetPropsInfoPropId ( int  prop )

inline

Definition at line 58 of file drmplane.h.

References m_propsInfo.

Referenced by SetPropertyRequest().

GetSrcH()

uint64_t cDrmPlane::GetSrcH ( void  )

inline

Definition at line 52 of file drmplane.h.

References m_srcH.

Referenced by DumpParameters(), and SetPlane().

GetSrcW()

uint64_t cDrmPlane::GetSrcW ( void  )

inline

Definition at line 51 of file drmplane.h.

References m_srcW.

Referenced by DumpParameters(), and SetPlane().

GetSrcX()

uint64_t cDrmPlane::GetSrcX ( void  )

inline

Definition at line 49 of file drmplane.h.

References m_srcX.

Referenced by DumpParameters(), and SetPlane().

GetSrcY()

uint64_t cDrmPlane::GetSrcY ( void  )

inline

Definition at line 50 of file drmplane.h.

References m_srcY.

Referenced by DumpParameters(), and SetPlane().

GetType()

uint64_t cDrmPlane::GetType ( void  )

inline

Definition at line 41 of file drmplane.h.

References m_type.

Referenced by cDrmDevice::Init().

GetZpos()

uint64_t cDrmPlane::GetZpos ( void  )

inline

Definition at line 53 of file drmplane.h.

References m_zpos.

Referenced by DumpParameters(), cDrmDevice::Init(), and SetPlaneZpos().

HasZpos()

int cDrmPlane::HasZpos

(

int

fdDrm

)

Check, if the plane is able to set the zpos property.

Parameters

fdDrm

drm file descriptor

Return values

1	plane can use zpos
0	plane can't use zpos

Definition at line 179 of file drmplane.cpp.

References L_DRM, LOGDEBUG2, LOGERROR, and SetPlaneZpos().

Referenced by cDrmDevice::Init().

SetId()

void cDrmPlane::SetId ( uint32_t  id )

inline

Definition at line 40 of file drmplane.h.

References m_planeId.

Referenced by cDrmDevice::Init().

SetParams()

void cDrmPlane::SetParams	(	uint64_t	crtcId,
		uint64_t	fbId,
		uint64_t	crtcX,
		uint64_t	crtcY,
		uint64_t	crtcW,
		uint64_t	crtcH,
		uint64_t	srcX,
		uint64_t	srcY,
		uint64_t	srcW,
		uint64_t	srcH
	)

Caches the modesetting parameters of a plane.

These values are used for drm modesetting

Parameters

crtcId	Mode object ID of the crtc
fbId	Mode object ID of the drm framebuffer
crtcX	X offset of the destination rect
crtcY	Y offset of the destination rect
crtcW	width of the destination rect
crtcH	height of the destination rect
srcX	X offset of the source rect
srcY	Y offset of the source rect
srcW	width of the source rect
srccH	height of the source rect

Definition at line 86 of file drmplane.cpp.

References m_crtcH, m_crtcId, m_crtcW, m_crtcX, m_crtcY, m_fbId, m_srcH, m_srcW, m_srcX, and m_srcY.

SetPlane()

void cDrmPlane::SetPlane

(

drmModeAtomicReqPtr

ModeReq

)

Set all plane properties (except zpos)

Parameters

ModeReq

pointer to the atomic mode request

Definition at line 144 of file drmplane.cpp.

References GetCrtcH(), GetCrtcId(), GetCrtcW(), GetCrtcX(), GetCrtcY(), GetFbId(), GetSrcH(), GetSrcW(), GetSrcX(), GetSrcY(), and SetPropertyRequest().

SetPlaneZpos()

void cDrmPlane::SetPlaneZpos

(

drmModeAtomicReqPtr

ModeReq

)

Set the plane zpos property.

Parameters

ModeReq

pointer to the atomic mode request

Definition at line 134 of file drmplane.cpp.

References GetZpos(), and SetPropertyRequest().

Referenced by HasZpos().

SetPropertyRequest()

int cDrmPlane::SetPropertyRequest ( drmModeAtomicReqPtr  ModeReq, const char *  propName, uint64_t  value  )

private

Add the properties to the mode setting request.

Parameters

ModeReq	pointer to the atomic mode request
propName	name of the property to set
value	property value

Definition at line 109 of file drmplane.cpp.

References GetCountProps(), GetId(), GetPropsInfoName(), GetPropsInfoPropId(), and LOGDEBUG.

Referenced by ClearPlane(), SetPlane(), and SetPlaneZpos().

SetProps()

void cDrmPlane::SetProps ( drmModeObjectProperties *  props )

inline

Definition at line 60 of file drmplane.h.

References m_props.

Referenced by FillProperties().

SetType()

void cDrmPlane::SetType ( uint64_t  type )

inline

Definition at line 42 of file drmplane.h.

References m_type.

Referenced by cDrmDevice::Init().

SetZpos()

void cDrmPlane::SetZpos ( uint64_t  zpos )

inline

Definition at line 54 of file drmplane.h.

References m_zpos.

Referenced by cDrmDevice::Init().

Member Data Documentation

m_crtcH

uint64_t cDrmPlane::m_crtcH

private

CRTC_H.

Definition at line 77 of file drmplane.h.

Referenced by GetCrtcH(), and SetParams().

m_crtcId

uint64_t cDrmPlane::m_crtcId

private

CRTC_ID.

Definition at line 72 of file drmplane.h.

Referenced by GetCrtcId(), and SetParams().

m_crtcW

uint64_t cDrmPlane::m_crtcW

private

CRTC_W.

Definition at line 76 of file drmplane.h.

Referenced by GetCrtcW(), and SetParams().

m_crtcX

uint64_t cDrmPlane::m_crtcX

private

CRTC_X.

Definition at line 74 of file drmplane.h.

Referenced by GetCrtcX(), and SetParams().

m_crtcY

uint64_t cDrmPlane::m_crtcY

private

CRTC_Y.

Definition at line 75 of file drmplane.h.

Referenced by GetCrtcY(), and SetParams().

m_fbId

uint64_t cDrmPlane::m_fbId

private

FB_ID.

Definition at line 73 of file drmplane.h.

Referenced by GetFbId(), and SetParams().

m_planeId

uint32_t cDrmPlane::m_planeId = 0

private

the plane's ID

Definition at line 65 of file drmplane.h.

Referenced by GetId(), and SetId().

m_props

drmModeObjectProperties* cDrmPlane::m_props = nullptr

private

Definition at line 68 of file drmplane.h.

Referenced by FillProperties(), FreeProperties(), GetCountProps(), GetProps(), and SetProps().

m_propsInfo

drmModePropertyRes** cDrmPlane::m_propsInfo

private

Definition at line 69 of file drmplane.h.

Referenced by FillProperties(), FreeProperties(), GetPropsInfo(), GetPropsInfoElem(), GetPropsInfoName(), and GetPropsInfoPropId().

m_srcH

uint64_t cDrmPlane::m_srcH

private

SRC_H.

Definition at line 81 of file drmplane.h.

Referenced by GetSrcH(), and SetParams().

m_srcW

uint64_t cDrmPlane::m_srcW

private

SRC_W.

Definition at line 80 of file drmplane.h.

Referenced by GetSrcW(), and SetParams().

m_srcX

uint64_t cDrmPlane::m_srcX

private

SRC_X.

Definition at line 78 of file drmplane.h.

Referenced by GetSrcX(), and SetParams().

m_srcY

uint64_t cDrmPlane::m_srcY

private

SRC_Y.

Definition at line 79 of file drmplane.h.

Referenced by GetSrcY(), and SetParams().

m_type

uint64_t cDrmPlane::m_type = 0

private

type: DRM_PLANE_TYPE_PRIMARY or DRM_PLANE_TYPE_OVERLAY

Definition at line 66 of file drmplane.h.

Referenced by GetType(), and SetType().

m_zpos

uint64_t cDrmPlane::m_zpos = 0

private

ZPOS.

Definition at line 82 of file drmplane.h.

Referenced by GetZpos(), and SetZpos().

---

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

• drmplane.h
• drmplane.cpp