Mir
Public Attributes | List of all members
MirScreencastParameters Struct Reference

MirScreencastParameters is the structure of required information that you must provide to Mir in order to create a MirScreencast. More...

#include <client_types.h>

Public Attributes

MirRectangle region
 The rectangular region of the screen to capture - The region is specified in virtual screen space hence multiple screens can be captured simultaneously. More...
 
unsigned int width
 The width of the screencast which can be different than the screen region capture width. More...
 
unsigned int height
 The height of the screencast which can be different than the screen region capture height. More...
 
MirPixelFormat pixel_format
 The pixel format of the screencast. More...
 

Detailed Description

MirScreencastParameters is the structure of required information that you must provide to Mir in order to create a MirScreencast.

The width and height parameters can be used to down-scale the screencast For no scaling set them to the region width and height.

Member Data Documentation

◆ height

unsigned int MirScreencastParameters::height

The height of the screencast which can be different than the screen region capture height.

◆ pixel_format

MirPixelFormat MirScreencastParameters::pixel_format

The pixel format of the screencast.

It must be a supported format obtained from mir_connection_get_available_surface_formats.

◆ region

MirRectangle MirScreencastParameters::region

The rectangular region of the screen to capture - The region is specified in virtual screen space hence multiple screens can be captured simultaneously.

◆ width

unsigned int MirScreencastParameters::width

The width of the screencast which can be different than the screen region capture width.


The documentation for this struct was generated from the following file:

Copyright © 2012-2018 Canonical Ltd.
Generated on Thu 12 Jul 10:49:10 UTC 2018