IGT_FORMAT_ARGS()

#define             IGT_FORMAT_ARGS(f)

igt_get_fb_tile_size ()

void
igt_get_fb_tile_size (int fd,
                      uint64_t modifier,
                      int fb_bpp,
                      unsigned *width_ret,
                      unsigned *height_ret);

This function returns width and height of a tile based on the given tiling format.

igt_calc_fb_size ()

void
igt_calc_fb_size (int fd,
                  int width,
                  int height,
                  uint32_t format,
                  uint64_t modifier,
                  uint64_t *size_ret,
                  unsigned *stride_ret);

This function returns valid stride and size values for a framebuffer with the specified parameters.

igt_create_fb_with_bo_size ()

unsigned int
igt_create_fb_with_bo_size (int fd,
                            int width,
                            int height,
                            uint32_t format,
                            uint64_t modifier,
                            struct igt_fb *fb,
                            uint64_t bo_size,
                            unsigned  bo_stride);

This function allocates a gem buffer object suitable to back a framebuffer with the requested properties and then wraps it up in a drm framebuffer object of the requested size. All metadata is stored in fb .

The backing storage of the framebuffer is filled with all zeros, i.e. black for rgb pixel formats.

igt_create_fb ()

unsigned int
igt_create_fb (int fd,
               int width,
               int height,
               uint32_t format,
               uint64_t modifier,
               struct igt_fb *fb);

This function allocates a gem buffer object suitable to back a framebuffer with the requested properties and then wraps it up in a drm framebuffer object. All metadata is stored in fb .

The backing storage of the framebuffer is filled with all zeros, i.e. black for rgb pixel formats.

igt_create_color_fb ()

unsigned int
igt_create_color_fb (int fd,
                     int width,
                     int height,
                     uint32_t format,
                     uint64_t modifier,
                     double r,
                     double g,
                     double b,
                     struct igt_fb *fb);

This function allocates a gem buffer object suitable to back a framebuffer with the requested properties and then wraps it up in a drm framebuffer object. All metadata is stored in fb .

Compared to igt_create_fb() this function also fills the entire framebuffer with the given color, which is useful for some simple pipe crc based tests.

igt_create_pattern_fb ()

unsigned int
igt_create_pattern_fb (int fd,
                       int width,
                       int height,
                       uint32_t format,
                       uint64_t modifier,
                       struct igt_fb *fb);

This function allocates a gem buffer object suitable to back a framebuffer with the requested properties and then wraps it up in a drm framebuffer object. All metadata is stored in fb .

Compared to igt_create_fb() this function also draws the standard test pattern into the framebuffer.

igt_create_color_pattern_fb ()

unsigned int
igt_create_color_pattern_fb (int fd,
                             int width,
                             int height,
                             uint32_t format,
                             uint64_t modifier,
                             double r,
                             double g,
                             double b,
                             struct igt_fb *fb);

This function allocates a gem buffer object suitable to back a framebuffer with the requested properties and then wraps it up in a drm framebuffer object. All metadata is stored in fb .

Compared to igt_create_fb() this function also fills the entire framebuffer with the given color, and then draws the standard test pattern into the framebuffer.

igt_create_image_fb ()

unsigned int
igt_create_image_fb (int drm_fd,
                     int width,
                     int height,
                     uint32_t format,
                     uint64_t modifier,
                     const char *filename,
                     struct igt_fb *fb);

Create a framebuffer with the specified image. If width is zero the image width will be used. If height is zero the image height will be used.

igt_create_stereo_fb ()

unsigned int
igt_create_stereo_fb (int drm_fd,
                      drmModeModeInfo *mode,
                      uint32_t format,
                      uint64_t modifier);

Create a framebuffer for use with the stereo 3D mode specified by mode .

igt_fb_convert_with_stride ()

unsigned int
igt_fb_convert_with_stride (struct igt_fb *dst,
                            struct igt_fb *src,
                            uint32_t dst_fourcc,
                            uint64_t dst_modifier,
                            unsigned int stride);

This will convert a given src content to the dst_fourcc format, storing the result in the dst fb, allocating the dst fb underlying buffer with a stride of dst_stride stride.

Once done with dst , the caller will have to call igt_remove_fb() on it to free the associated resources.

igt_fb_convert ()

unsigned int
igt_fb_convert (struct igt_fb *dst,
                struct igt_fb *src,
                uint32_t dst_fourcc,
                uint64_t dst_modifier);

This will convert a given src content to the dst_fourcc format, storing the result in the dst fb, allocating the dst fb underlying buffer.

Once done with dst , the caller will have to call igt_remove_fb() on it to free the associated resources.

igt_remove_fb ()

void
igt_remove_fb (int fd,
               struct igt_fb *fb);

This function releases all resources allocated in igt_create_fb() for fb . Note that if this framebuffer is still in use on a primary plane the kernel will disable the corresponding crtc.

igt_dirty_fb ()

int
igt_dirty_fb (int fd,
              struct igt_fb *fb);

Flushes out the whole framebuffer.

igt_fb_map_buffer ()

void *
igt_fb_map_buffer (int fd,
                   struct igt_fb *fb);

This function will creating a new mapping of the buffer and return a pointer to the content of the supplied framebuffer's plane. This mapping needs to be deleted using igt_fb_unmap_buffer().

igt_fb_unmap_buffer ()

void
igt_fb_unmap_buffer (struct igt_fb *fb,
                     void *buffer);

This function will unmap a buffer mapped previously with igt_fb_map_buffer().

igt_create_bo_for_fb ()

void
igt_create_bo_for_fb (int fd,
                      int width,
                      int height,
                      uint32_t format,
                      uint64_t modifier,
                      struct igt_fb *fb);

igt_create_bo_with_dimensions ()

int
igt_create_bo_with_dimensions (int fd,
                               int width,
                               int height,
                               uint32_t format,
                               uint64_t modifier,
                               unsigned  stride,
                               uint64_t *size_ret,
                               unsigned *stride_ret,
                               bool *is_dumb);

This function allocates a gem buffer object matching the requested properties.

igt_fb_calc_crc ()

void
igt_fb_calc_crc (struct igt_fb *fb,
                 igt_crc_t *crc);

This function calculate the 16-bit frame CRC of RGB components over all the active pixels.

igt_fb_mod_to_tiling ()

uint64_t
igt_fb_mod_to_tiling (uint64_t modifier);

This function converts a DRM framebuffer modifier to its corresponding tiling constant.

igt_fb_tiling_to_mod ()

uint64_t
igt_fb_tiling_to_mod (uint64_t tiling);

This function converts a DRM framebuffer tiling to its corresponding modifier constant.

igt_get_cairo_surface ()

cairo_surface_t *
igt_get_cairo_surface (int fd,
                       struct igt_fb *fb);

This function stores the contents of the supplied framebuffer's plane into a cairo surface and returns it.

igt_cairo_image_surface_create_from_png ()

cairo_surface_t *
igt_cairo_image_surface_create_from_png
                               (const char *filename);

igt_get_cairo_ctx ()

cairo_t *
igt_get_cairo_ctx (int fd,
                   struct igt_fb *fb);

This initializes a cairo surface for fb and then allocates a drawing context for it. The return cairo drawing context should be released by calling igt_put_cairo_ctx(). This also sets a default font for drawing text on framebuffers.

igt_put_cairo_ctx ()

void
igt_put_cairo_ctx (int fd,
                   struct igt_fb *fb,
                   cairo_t *cr);

This releases the cairo surface cr returned by igt_get_cairo_ctx() for fb , and writes the changes out to the framebuffer if cairo doesn't have native support for the format.

igt_paint_color ()

void
igt_paint_color (cairo_t *cr,
                 int x,
                 int y,
                 int w,
                 int h,
                 double r,
                 double g,
                 double b);

This functions draws a solid rectangle with the given color using the drawing context cr .

igt_paint_color_alpha ()

void
igt_paint_color_alpha (cairo_t *cr,
                       int x,
                       int y,
                       int w,
                       int h,
                       double r,
                       double g,
                       double b,
                       double a);

This functions draws a rectangle with the given color and alpha values using the drawing context cr .

igt_paint_color_gradient ()

void
igt_paint_color_gradient (cairo_t *cr,
                          int x,
                          int y,
                          int w,
                          int h,
                          int r,
                          int g,
                          int b);

This functions draws a gradient into the rectangle which fades in from black to the given values using the drawing context cr .

igt_paint_color_gradient_range ()

void
igt_paint_color_gradient_range (cairo_t *cr,
                                int x,
                                int y,
                                int w,
                                int h,
                                double sr,
                                double sg,
                                double sb,
                                double er,
                                double eg,
                                double eb);

This functions draws a gradient into the rectangle which fades in from one color to the other using the drawing context cr .

igt_paint_test_pattern ()

void
igt_paint_test_pattern (cairo_t *cr,
                        int width,
                        int height);

This functions draws an entire set of test patterns for the given visible area using the drawing context cr . This is useful for manual visual inspection of displayed framebuffers.

The test patterns include

igt_paint_image ()

void
igt_paint_image (cairo_t *cr,
                 const char *filename,
                 int dst_x,
                 int dst_y,
                 int dst_width,
                 int dst_height);

This function can be used to draw a scaled version of the supplied png image, which is loaded from the package data directory.

igt_cairo_printf_line ()

int
igt_cairo_printf_line (cairo_t *cr,
                       enum igt_text_align align,
                       double yspacing,
                       const char *fmt,
                       ...);

This is a little helper to draw text onto framebuffers. All the initial setup (like setting the font size and the moving to the starting position) still needs to be done manually with explicit cairo calls on cr .

igt_bpp_depth_to_drm_format ()

uint32_t
igt_bpp_depth_to_drm_format (int bpp,
                             int depth);

igt_drm_format_to_bpp ()

uint32_t
igt_drm_format_to_bpp (uint32_t drm_format);

igt_format_str ()

const char *
igt_format_str (uint32_t drm_format);

igt_fb_supported_format ()

bool
igt_fb_supported_format (uint32_t drm_format);

This functions returns whether drm_format can be succesfully created by igt_create_fb() and drawn to by igt_get_cairo_ctx().

igt_format_is_yuv ()

bool
igt_format_is_yuv (uint32_t drm_format);

This functions returns whether drm_format is YUV (as opposed to RGB).

igt_format_is_fp16 ()

bool
igt_format_is_fp16 (uint32_t drm_format);

Check if the format is fp16.

igt_format_plane_bpp ()

int
igt_format_plane_bpp (uint32_t drm_format,
                      int plane);

This functions returns the number of bits per pixel for the given plane index of the drm_format .

igt_format_array_fill ()

void
igt_format_array_fill (uint32_t **formats_array,
                       unsigned int *count,
                       bool allow_yuv);

This functions allocates and fills a formats_array that lists the DRM formats current available.

IGT_FORMAT_FLOAT

#define IGT_FORMAT_FLOAT fourcc_code('I', 'G', 'F', 'x')

IGT_FORMAT_FMT

#define IGT_FORMAT_FMT "%c%c%c%c(0x%08x)"

igt_fb_t

typedef struct {
	uint32_t fb_id;
	int fd;
	uint32_t gem_handle;
	bool is_dumb;
	uint32_t drm_format;
	int width;
	int height;
	enum igt_color_encoding color_encoding;
	enum igt_color_range color_range;
	uint64_t modifier;
	uint64_t size;
	cairo_surface_t *cairo_surface;
	unsigned int domain;
	unsigned int num_planes;
	uint32_t strides[4];
	uint32_t offsets[4];
	unsigned int plane_bpp[4];
	unsigned int plane_width[4];
	unsigned int plane_height[4];
} igt_fb_t;

Tracking structure for KMS framebuffer objects.

enum igt_text_align

Alignment mode for text drawing using igt_cairo_printf_line().