man/drmModeGetResources.man

   1 .\" shorthand for double quote that works everywhere.
   2 .ds q \N'34'
   3 .TH drmModeGetResources  __drivermansuffix__ __vendorversion__
   4 .SH NAME
   5 drmModeGetResources \- retrieve current display configuration information
   6 .SH SYNOPSIS
   7 .nf
   8 .B "#include <xf86drmMode.h>"
   9
  10 .BI "typedef struct _drmModeRes {"
  11
  12 .BI "   int count_fbs;"
  13 .BI "   uint32_t *fbs;"
  14
  15 .BI "   int count_crtcs;"
  16 .BI "   uint32_t *crtcs;"
  17
  18 .BI "   int count_connectors;"
  19 .BI "   uint32_t *connectors;"
  20
  21 .BI "   int count_encoders;"
  22 .BI "   uint32_t *encoders;"
  23
  24 .BI "   uint32_t min_width, max_width;"
  25 .BI "   uint32_t min_height, max_height;"
  26 .B "} drmModeRes, *drmModeResPtr;"
  27
  28 .B "drmModeResPtr drmModeGetResources(int fd);"
  29 .fi
  30 .SH DESCRIPTION
  31 This function will allocate, populate, and return a drmModeRes structure
  32 containing information about the current display configuration.
  33
  34 The
  35 .I count_fbs
  36 and
  37 .I fbs
  38 fields indicate the number of currently allocated framebuffer objects (i.e.
  39 objects that can be attached to a given CRTC or sprite for display).
  40
  41 The
  42 .I count_crtcs
  43 and
  44 .I crtcs
  45 fields list the available CRTCs in the configuration.  A CRTC is simply
  46 an object that can scan out a framebuffer to a display sink, and contains
  47 mode timing and relative position information.  CRTCs drive encoders, which
  48 are responsible for converting the pixel stream into a specific display
  49 protocol (e.g. MIPI or HDMI).
  50
  51 The
  52 .I count_connectors
  53 and
  54 .I connectors
  55 fields list the available physical connectors on the system.  Note that
  56 some of these may not be exposed from the chassis (e.g. LVDS or eDP).
  57 Connectors are attached to encoders and contain information about the
  58 attached display sink (e.g. width and height in mm, subpixel ordering, and
  59 various other properties).
  60
  61 The
  62 .I count_encoders
  63 and
  64 .I encoders
  65 fields list the available encoders on the device.  Each encoder may be
  66 associated with a CRTC, and may be used to drive a particular encoder.
  67
  68 The min and max height fields indicate the maximum size of a framebuffer
  69 for this device (i.e. the scanout size limit).
  70
  71 .SH RETURN VALUE
  72 Returns a drmModeRes structure pointer on success, 0 on failure.
  73
  74 .SH REPORTING BUGS
  75 Bugs in this function should be reported to http://bugs.freedesktop.org under
  76 the "Mesa" product, with "Other" or "libdrm" as the component.
  77
  78 .SH "SEE ALSO"
  79 drmModeGetFB(__libmansuffix__), drmModeAddFB(__libmansuffix__), drmModeAddFB2(__libmansuffix__), drmModeRmFB(__libmansuffix__), drmModeDirtyFB(__libmansuffix__), drmModeGetCrtc(__libmansuffix__), drmModeSetCrtc(__libmansuffix__), drmModeGetEncoder(__libmansuffix__), drmModeGetConnector(__libmansuffix__)