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 
22 
23 #ifdef __cplusplus
24 
28 extern "C" {
29 #endif
30 
42 
50 void mir_screencast_spec_set_width(MirScreencastSpec* spec, unsigned int width);
51 
60 
69 
70 
80 
89 
97 void mir_screencast_spec_set_number_of_buffers(MirScreencastSpec* spec, unsigned int nbuffers);
98 
105 
113 
120 bool mir_screencast_is_valid(MirScreencast *screencast);
121 
132 char const *mir_screencast_get_error_message(MirScreencast *screencast);
133 
145  MirConnection* connection,
146  MirScreencastParameters* parameters)
147 MIR_FOR_REMOVAL_IN_VERSION_1("use mir_screencast_create_sync instead");
148 
154  MirScreencast* screencast);
155 
163 
164 #ifdef __cplusplus
165 }
167 #endif
168 
169 #endif /* MIR_TOOLKIT_MIR_SCREENCAST_H_ */
void mir_screencast_spec_set_capture_region(MirScreencastSpec *spec, MirRectangle const *region)
Set the rectangular region to capture.
struct MirBufferStream MirBufferStream
Definition: client_types.h:49
MirScreencastParameters is the structure of required information that you must provide to Mir in orde...
Definition: client_types.h:406
void mir_screencast_spec_set_number_of_buffers(MirScreencastSpec *spec, unsigned int nbuffers)
Set the requested number of buffers to use.
struct MirScreencast MirScreencast
Definition: client_types.h:46
#define MIR_FOR_REMOVAL_IN_VERSION_1(message)
Definition: deprecations.h:30
struct MirScreencastSpec MirScreencastSpec
Definition: client_types.h:47
unsigned int height
Definition: mir_image.h:27
MirBufferStream * mir_screencast_get_buffer_stream(MirScreencast *screencast)
Retrieve the MirBufferStream associated with a screencast (to advance buffers, obtain EGLNativeWindow...
char const * mir_screencast_get_error_message(MirScreencast *screencast)
Retrieve a text description of the error.
void mir_screencast_release_sync(MirScreencast *screencast)
Release the specified screencast.
void mir_screencast_spec_set_height(MirScreencastSpec *spec, unsigned int height)
Set the requested height, in pixels.
unsigned int width
Definition: mir_image.h:26
MirScreencastSpec * mir_create_screencast_spec(MirConnection *connection)
Create a screencast specification.
void mir_screencast_spec_set_mirror_mode(MirScreencastSpec *spec, MirMirrorMode mode)
Set the requested mirror mode.
struct MirConnection MirConnection
Definition: client_types.h:41
MirMirrorMode
Mirroring axis relative to the "natural" orientation of the display.
Definition: common.h:280
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition: common.h:241
MirScreencast * mir_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.
bool mir_screencast_is_valid(MirScreencast *screencast)
Test for a valid screencast.
void mir_screencast_spec_release(MirScreencastSpec *spec)
Release the resources held by a MirScreencastSpec.
MirScreencast * mir_screencast_create_sync(MirScreencastSpec *spec)
Create a screencast from a given specification.
void mir_screencast_spec_set_pixel_format(MirScreencastSpec *spec, MirPixelFormat format)
Set the requested pixel format.
Definition: client_types.h:387
void mir_screencast_spec_set_width(MirScreencastSpec *spec, unsigned int width)
Set the requested width, in pixels.

Copyright © 2012-2016 Canonical Ltd.
Generated on Mon Jun 5 13:49:26 UTC 2017