Mir
Typedefs | Enumerations | Functions
mir_screencast.h File Reference
#include <mir_toolkit/client_types.h>
#include <mir_toolkit/deprecations.h>
Include dependency graph for mir_screencast.h:

Go to the source code of this file.

Typedefs

typedef enum MirScreencastResult MirScreencastResult
 
typedef void(* MirScreencastBufferCallback) (MirScreencastResult status, MirBuffer *buffer, void *context)
 

Enumerations

enum  MirScreencastResult { mir_screencast_success , mir_screencast_error_failure }
 

Functions

MirScreencastSpecmir_create_screencast_spec (MirConnection *connection)
 Create a screencast specification. More...
 
void mir_screencast_spec_set_width (MirScreencastSpec *spec, unsigned int width)
 Set the requested width, in pixels. More...
 
void mir_screencast_spec_set_height (MirScreencastSpec *spec, unsigned int height)
 Set the requested height, in pixels. More...
 
void mir_screencast_spec_set_pixel_format (MirScreencastSpec *spec, MirPixelFormat format)
 Set the requested pixel format. More...
 
void mir_screencast_spec_set_capture_region (MirScreencastSpec *spec, MirRectangle const *region)
 Set the rectangular region to capture. More...
 
void mir_screencast_spec_set_mirror_mode (MirScreencastSpec *spec, MirMirrorMode mode)
 Set the requested mirror mode. More...
 
void mir_screencast_spec_set_number_of_buffers (MirScreencastSpec *spec, unsigned int nbuffers)
 Set the requested number of buffers to use. More...
 
void mir_screencast_spec_release (MirScreencastSpec *spec)
 Release the resources held by a MirScreencastSpec. More...
 
MirScreencastmir_screencast_create_sync (MirScreencastSpec *spec)
 Create a screencast from a given specification. More...
 
bool mir_screencast_is_valid (MirScreencast *screencast)
 Test for a valid screencast. More...
 
char const * mir_screencast_get_error_message (MirScreencast *screencast)
 Retrieve a text description of the error. More...
 
MirScreencastmir_connection_create_screencast_sync (MirConnection *connection, MirScreencastParameters *parameters) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_screencast_create_sync instead")
 Create a screencast on the supplied connection. More...
 
void mir_screencast_release_sync (MirScreencast *screencast)
 Release the specified screencast. More...
 
MirBufferStreammir_screencast_get_buffer_stream (MirScreencast *screencast)
 Retrieve the MirBufferStream associated with a screencast (to advance buffers, obtain EGLNativeWindowType, etc...) More...
 
void mir_screencast_capture_to_buffer (MirScreencast *screencast, MirBuffer *buffer, MirScreencastBufferCallback available_callback, void *available_context)
 Capture the contents of the screen to a particular buffer. More...
 
MirScreencastResult mir_screencast_capture_to_buffer_sync (MirScreencast *screencast, MirBuffer *buffer)
 Capture the contents of the screen to a particular buffer and wait for the capture to complete. More...
 

Copyright © 2012-2021 Canonical Ltd.
Generated on Thu Nov 11 16:37:50 UTC 2021
This documentation is licensed under the GPL version 2 or 3.