SRMPlane

DRM plane associated with a DRM device. More...

Detailed Description

DRM plane associated with a DRM device.

The SRMPlane module provides functions for querying information about planes associated with DRM devices. These planes can be used for various purposes, such as displaying content on connectors.

Note

This module is primarily used by SRM internally and may not be of much use to users.

Enumerations
enum	SRM_PLANE_TYPE
	Enumeration of plane types. More...

Functions
UInt32	srmPlaneGetID (SRMPlane *plane)
	Get the unique identifier of a DRM plane. More...
SRMDevice *	srmPlaneGetDevice (SRMPlane *plane)
	Get the DRM device to which a DRM plane belongs. More...
SRMList *	srmPlaneGetCrtcs (SRMPlane *plane)
	Get a list of CRTCs associated with a DRM plane. More...
SRMConnector *	srmPlaneGetCurrentConnector (SRMPlane *plane)
	Get the current connector associated with a DRM plane. More...
SRM_PLANE_TYPE	srmPlaneGetType (SRMPlane *plane)
	Get the type of a DRM plane. More...
SRMList *	srmPlaneGetFormats (SRMPlane *plane)
	Get a list of DRM framebuffer formats supported by the plane. *. More...

Typedef Documentation

SRMPlane

typedef struct SRMPlaneStruct SRMPlane

Enumeration Type Documentation

SRM_PLANE_TYPE

enum SRM_PLANE_TYPE

Enumeration of plane types.

Enumerator
SRM_PLANE_TYPE_OVERLAY	The plane type is "OVERLAY.".
SRM_PLANE_TYPE_PRIMARY	The plane type is "PRIMARY.".
SRM_PLANE_TYPE_CURSOR	The plane type is "CURSOR.".

Function Documentation

srmPlaneGetID()

UInt32 srmPlaneGetID

(

SRMPlane *

plane

)

Get the unique identifier of a DRM plane.

Parameters

plane

A pointer to the SRMPlane instance.

Returns

The unique identifier of the DRM plane.

srmPlaneGetDevice()

SRMDevice* srmPlaneGetDevice

(

SRMPlane *

plane

)

Get the DRM device to which a DRM plane belongs.

Parameters

plane

A pointer to the SRMPlane instance.

Returns

A pointer to the SRMDevice representing the DRM device.

srmPlaneGetCrtcs()

SRMList* srmPlaneGetCrtcs

(

SRMPlane *

plane

)

Get a list of CRTCs associated with a DRM plane.

Parameters

plane

A pointer to the SRMPlane instance.

Returns

A list of SRMCrtc instances representing the CRTCs associated with the plane.

srmPlaneGetCurrentConnector()

SRMConnector* srmPlaneGetCurrentConnector

(

SRMPlane *

plane

)

Get the current connector associated with a DRM plane.

Parameters

plane

A pointer to the SRMPlane instance.

Returns

A pointer to the SRMConnector representing the current connector, or NULL if not associated with any.

srmPlaneGetType()

SRM_PLANE_TYPE srmPlaneGetType

(

SRMPlane *

plane

)

Get the type of a DRM plane.

Parameters

plane

A pointer to the SRMPlane instance.

Returns

The type of the DRM plane, as an SRM_PLANE_TYPE enumeration value.

srmPlaneGetFormats()

SRMList* srmPlaneGetFormats

(

SRMPlane *

plane

)

Get a list of DRM framebuffer formats supported by the plane. *.

Parameters

plane

A pointer to the SRMPlane instance.

Returns

A list of DRM formats/modifiers supported by the plane.