Mir
mir_screencast.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2014 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU Lesser General Public License version 3,
6  * as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  */
16 
17 #ifndef MIR_TOOLKIT_MIR_SCREENCAST_H_
18 #define MIR_TOOLKIT_MIR_SCREENCAST_H_
19 
21 
22 #ifdef __cplusplus
23 
27 extern "C" {
28 #endif
29 
41 
49 void mir_screencast_spec_set_width(MirScreencastSpec* spec, unsigned int width);
50 
59 
68 
69 
79 
88 
96 void mir_screencast_spec_set_number_of_buffers(MirScreencastSpec* spec, unsigned int nbuffers);
97 
104 
112 
119 bool mir_screencast_is_valid(MirScreencast *screencast);
120 
131 char const *mir_screencast_get_error_message(MirScreencast *screencast);
132 
144  MirConnection* connection,
145  MirScreencastParameters* parameters);
146 
152  MirScreencast* screencast);
153 
161 
162 #ifdef __cplusplus
163 }
165 #endif
166 
167 #endif /* MIR_TOOLKIT_MIR_SCREENCAST_H_ */
Definition: mir_screencast.h:50
void mir_screencast_spec_set_capture_region(MirScreencastSpec *spec, MirRectangle const *region)
Set the rectangular region to capture.
Definition: mir_screencast_api.cpp:67
MirScreencast * mir_connection_create_screencast_sync(MirConnection *connection, MirScreencastParameters *parameters)
Create a screencast on the supplied connection.
Definition: mir_screencast_api.cpp:109
struct MirBufferStream MirBufferStream
Definition: client_types.h:46
MirScreencastParameters is the structure of required information that you must provide to Mir in orde...
Definition: client_types.h:388
void mir_screencast_spec_set_number_of_buffers(MirScreencastSpec *spec, unsigned int nbuffers)
Set the requested number of buffers to use.
Definition: mir_screencast_api.cpp:77
Definition: mir_screencast.h:69
MirBufferStream * mir_screencast_get_buffer_stream(MirScreencast *screencast)
Retrieve the MirBufferStream associated with a screencast (to advance buffers, obtain EGLNativeWindow...
Definition: mir_screencast_api.cpp:124
char const * mir_screencast_get_error_message(MirScreencast *screencast)
Retrieve a text description of the error.
Definition: mir_screencast_api.cpp:103
void mir_screencast_release_sync(MirScreencast *screencast)
Release the specified screencast.
Definition: mir_screencast_api.cpp:118
void mir_screencast_spec_set_height(MirScreencastSpec *spec, unsigned int height)
Set the requested height, in pixels.
Definition: mir_screencast_api.cpp:57
MirScreencastSpec * mir_create_screencast_spec(MirConnection *connection)
Create a screencast specification.
Definition: mir_screencast_api.cpp:46
void mir_screencast_spec_set_mirror_mode(MirScreencastSpec *spec, MirMirrorMode mode)
Set the requested mirror mode.
Definition: mir_screencast_api.cpp:72
MirMirrorMode
Mirroring axis relative to the "natural" orientation of the display.
Definition: common.h:173
unsigned int width
Definition: touchspot_image.c:4
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition: common.h:134
bool mir_screencast_is_valid(MirScreencast *screencast)
Test for a valid screencast.
Definition: mir_screencast_api.cpp:98
void mir_screencast_spec_release(MirScreencastSpec *spec)
Release the resources held by a MirScreencastSpec.
Definition: mir_screencast_api.cpp:82
MirScreencast * mir_screencast_create_sync(MirScreencastSpec *spec)
Create a screencast from a given specification.
Definition: mir_screencast_api.cpp:87
void mir_screencast_spec_set_pixel_format(MirScreencastSpec *spec, MirPixelFormat format)
Set the requested pixel format.
Definition: mir_screencast_api.cpp:62
unsigned int height
Definition: touchspot_image.c:5
Definition: mir_connection.h:96
Definition: client_types.h:371
void mir_screencast_spec_set_width(MirScreencastSpec *spec, unsigned int width)
Set the requested width, in pixels.
Definition: mir_screencast_api.cpp:52

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Sep 8 14:50:19 UTC 2016