Mir
mir_render_surface.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2016 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  * Authored by:
17  * Cemil Azizoglu <cemil.azizoglu@canonical.com>
18  */
19 
20 #ifndef MIR_TOOLKIT_MIR_RENDER_SURFACE_H_
21 #define MIR_TOOLKIT_MIR_RENDER_SURFACE_H_
22 
25 
26 #ifdef __cplusplus
27 
31 extern "C" {
32 #endif
33 
34 #pragma GCC diagnostic push
35 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
36 
49  MirConnection* connection,
50  int width, int height,
51  MirRenderSurfaceCallback callback,
52  void* context)
53 MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
54 
66  MirConnection* connection,
67  int width, int height)
68 MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
69 
78  MirRenderSurface* render_surface,
79  int* width, int* height)
80 MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
81 
90  MirRenderSurface* render_surface,
91  int width, int height)
92 MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
93 
103  MirRenderSurface* render_surface)
104 MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
105 
116  MirRenderSurface* render_surface)
117 MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
118 
125  MirRenderSurface* render_surface)
126 MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
127 
143  MirRenderSurface* render_surface,
144  int width, int height,
145  MirPixelFormat format)
146 MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
147 
158  MirRenderSurface* render_surface)
159 MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
160 
168  MirConnection* connection, MirPresentMode mode);
169 
179  MirPresentationChain* chain, MirPresentMode mode);
180 
190  MirWindowSpec* spec,
191  MirRenderSurface* render_surface,
192  int hotspot_x, int hotspot_y)
193 MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
194 
195 #pragma GCC diagnostic pop
196 
197 #ifdef __cplusplus
198 }
200 #endif
201 
202 #endif // MIR_TOOLKIT_MIR_RENDER_SURFACE_H_
char const * mir_render_surface_get_error_message(MirRenderSurface *render_surface) MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface- -> MirSurface transition")
Retrieve a text description of the error.
void mir_connection_create_render_surface(MirConnection *connection, int width, int height, MirRenderSurfaceCallback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface- -> MirSurface transition")
Create a render surface.
struct MirBufferStream MirBufferStream
Definition: client_types.h:49
bool mir_render_surface_is_valid(MirRenderSurface *render_surface) MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface- -> MirSurface transition")
Test for a valid render surface.
MirBufferStream * mir_render_surface_get_buffer_stream(MirRenderSurface *render_surface, int width, int height, MirPixelFormat format) MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface- -> MirSurface transition")
Obtain the buffer stream backing a given render surface.
void(* MirRenderSurfaceCallback)(MirRenderSurface *, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("This type is slated for rename due to MirRenderSurface- -> MirSurface transition")
Definition: client_types.h:559
MirPresentMode
Definition: client_types.h:258
#define MIR_FOR_REMOVAL_IN_VERSION_1(message)
Definition: deprecations.h:30
unsigned int height
Definition: mir_image.h:27
MirPresentationChain * mir_render_surface_get_presentation_chain(MirRenderSurface *render_surface) MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface- -> MirSurface transition")
Obtain the presentation chain backing a given render surface.
void mir_presentation_chain_set_mode(MirPresentationChain *chain, MirPresentMode mode)
Respecify the submission mode that the MirPresentationChain is operating with.
unsigned int width
Definition: mir_image.h:26
void mir_render_surface_set_size(MirRenderSurface *render_surface, int width, int height) MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface- -> MirSurface transition")
Set the size of the MirRenderSurface.
void mir_render_surface_release(MirRenderSurface *render_surface) MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface- -> MirSurface transition")
Release the specified render surface.
void mir_window_spec_set_cursor_render_surface(MirWindowSpec *spec, MirRenderSurface *render_surface, int hotspot_x, int hotspot_y) MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface- -> MirSurface transition")
Set the MirWindowSpec to contain a specific cursor.
struct MirConnection MirConnection
Definition: client_types.h:41
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition: common.h:241
struct MirPresentationChain MirPresentationChain
Definition: client_types.h:55
struct MirSurfaceSpec MirWindowSpec
Definition: client_types.h:45
void mir_render_surface_get_size(MirRenderSurface *render_surface, int *width, int *height) MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface- -> MirSurface transition")
Get the size of the MirRenderSurface.
MirRenderSurface * mir_connection_create_render_surface_sync(MirConnection *connection, int width, int height) MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface- -> MirSurface transition")
Create a render surface and wait for the result.
bool mir_connection_present_mode_supported(MirConnection *connection, MirPresentMode mode)
Query whether the server supports a given presentation mode.

Copyright © 2012-2016 Canonical Ltd.
Generated on Wed May 10 10:41:27 UTC 2017