From 6b7e45c7516b7fdfe85e7792f82624458dcb2ac6 Mon Sep 17 00:00:00 2001 From: David Herrmann Date: Fri, 28 Sep 2012 23:44:19 +0200 Subject: man: convert manpages to XML instead of plain troff If we want to use the manpages in external documentation other than normal manpages, we should rather use XML. Furthermore, almost no-one knows troff today, anyway, and XML allows others to easily add more pages without having to learn troff. Signed-off-by: David Herrmann --- man/drmModeGetResources.xml | 139 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 139 insertions(+) create mode 100644 man/drmModeGetResources.xml (limited to 'man/drmModeGetResources.xml') diff --git a/man/drmModeGetResources.xml b/man/drmModeGetResources.xml new file mode 100644 index 00000000..2f5e8c2c --- /dev/null +++ b/man/drmModeGetResources.xml @@ -0,0 +1,139 @@ + + + + + + + + Direct Rendering Manager + libdrm + September 2012 + + + Developer + David + Herrmann + dh.herrmann@googlemail.com + + + + + + drmModeGetResources + 3 + + + + drmModeGetResources + retrieve current display configuration information + + + + + + #include <xf86drm.h> + #include <xf86drmMode.h> + + + drmModeResPtr drmModeGetResources + int fd + + + + + + + Description + drmModeGetResources allocates, populates, and + returns a drmModeRes structure containing + information about the current display configuration. The structure + contains the following fields: + + +typedef struct _drmModeRes { + int count_fbs; + uint32_t *fbs; + + int count_crtcs; + uint32_t *crtcs; + + int count_connectors; + uint32_t *connectors; + + int count_encoders; + uint32_t *encoders; + + uint32_t min_width, max_width; + uint32_t min_height, max_height; +} drmModeRes, *drmModeResPtr; + + + + + The count_fbs and + fbs fields indicate the number of currently + allocated framebuffer objects (i.e., objects that can be attached to + a given CRTC or sprite for display). + + The count_crtcs and + crtcs fields list the available CRTCs in + the configuration. A CRTC is simply an object that can scan out a + framebuffer to a display sink, and contains mode timing and relative + position information. CRTCs drive encoders, which are responsible for + converting the pixel stream into a specific display protocol (e.g., + MIPI or HDMI). + + The count_connectors and + connectors fields list the available + physical connectors on the system. Note that some of these may not be + exposed from the chassis (e.g., LVDS or eDP). Connectors are attached + to encoders and contain information about the attached display sink + (e.g., width and height in mm, subpixel ordering, and various other + properties). + + The count_encoders and + encoders fields list the available encoders + on the device. Each encoder may be associated with a CRTC, and may be + used to drive a particular encoder. + + The min* and + max* fields indicate the maximum size of a + framebuffer for this device (i.e., the scanout size limit). + + + + Return Value + drmModeGetResources returns a drmModeRes + structure pointer on success, NULL on failure. The + returned structure must be freed with + drmModeFreeResources3. + + + + Reporting Bugs + Bugs in this function should be reported to + http://bugs.freedesktop.org under the "Mesa" product, with "Other" or + "libdrm" as the component. + + + + See Also + + drm7, + drm-kms7, + drmModeGetFB3, + drmModeAddFB3, + drmModeAddFB23, + drmModeRmFB3, + drmModeDirtyFB3, + drmModeGetCrtc3, + drmModeSetCrtc3, + drmModeGetEncoder3, + drmModeGetConnector3 + + + -- cgit v1.2.3