1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
/*
* Copyright © 2015 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef MIR_TOOLKIT_MIR_BUFFER_STREAM_H_
#define MIR_TOOLKIT_MIR_BUFFER_STREAM_H_
#include <mir_toolkit/mir_native_buffer.h>
#include <mir_toolkit/client_types.h>
#ifdef __cplusplus
/**
* \addtogroup mir_toolkit
* @{
*/
extern "C" {
#endif
/**
* Test for a valid buffer stream
*
* \param [in] buffer_stream The buffer stream
* \return True if the supplied buffer_stream is valid, or
* false otherwise.
*/
bool mir_buffer_stream_is_valid(MirBufferStream *buffer_stream);
/**
* Retrieve a text description of the error. The returned string is owned by
* the library and remains valid until the stream or the associated
* connection has been released.
* \param [in] buffer_stream The buffer stream
* \return A text description of any error resulting in an
* invalid stream, or the empty string "" if the
* connection is valid.
*/
char const *mir_buffer_stream_get_error_message(MirBufferStream *buffer_stream);
/**
* Create a new buffer stream.
*
* // FIXME Waiting for mir_render_surface_create_buffer_stream
*
* For example, the resulting buffer stream may be used
* with mir_cursor_configuration_from_buffer_stream,
* in order to post images to the system cursor.
*
* \param [in] connection A valid connection
* \param [in] width Requested buffer width
* \param [in] height Requested buffer height
* \param [in] format Requested pixel format
* \param [in] buffer_usage Requested buffer usage, use
* mir_buffer_usage_software for cursor image streams
* \param [in] callback Callback to be invoked when the request completes
* The callback is guaranteed to be called and called with a
* non-null MirBufferStream*, but the stream may be invalid in
* case of an error.
* \param [in] context Userdata to pass to callback function
*
* \return A handle that can be supplied to mir_wait_for
*/
MirWaitHandle* mir_connection_create_buffer_stream(MirConnection *connection,
int width, int height,
MirPixelFormat format,
MirBufferUsage buffer_usage,
mir_buffer_stream_callback callback,
void* context);
/**
* Create a new buffer stream unattached to a surface and wait for the result.
* The resulting buffer stream may be used with
* mir_cursor_configuration_from_buffer_stream in order to post images
* to the system cursor.
*
* // FIXME Waiting for mir_render_surface_create_buffer_stream_sync
*
* \param [in] connection A valid connection
* \param [in] width Requested buffer width
* \param [in] height Requested buffer height
* \param [in] format Requested pixel format
* \param [in] buffer_usage Requested buffer usage, use
* mir_buffer_usage_software for cursor image streams
*
* \return The new buffer stream. This is guaranteed non-null,
* but may be invalid in the case of error.
*/
MirBufferStream* mir_connection_create_buffer_stream_sync(MirConnection *connection,
int width, int height,
MirPixelFormat format,
MirBufferUsage buffer_usage);
/**
* Release the supplied stream and any associated buffer. The returned wait
*
* \note TODO: Cleanup remove callback?
*
* handle remains valid until the connection to the server is released.
* \warning callback could be called from another thread. You must do any
* locking appropriate to protect your data accessed in the
* callback.
* \param [in] buffer_stream The stream
* \param [in] callback Callback function to be invoked when the request
* completes
* \param [in,out] context User data passed to the callback function
* \return A handle that can be passed to mir_wait_for
*/
MirWaitHandle *mir_buffer_stream_release(
MirBufferStream * buffer_stream,
mir_buffer_stream_callback callback,
void *context);
/**
* Release the specified buffer stream like in mir,_buffer_stream_release(),
* but also wait for the operation to complete.
* \param [in] buffer_stream The buffer stream to be released
*/
void mir_buffer_stream_release_sync(MirBufferStream *buffer_stream);
/**
* Get the underlying platform type so the buffer obtained in "raw"
* representation in mir_buffer_stream_get_current_buffer()
* may be understood
*
* \deprecated Use of this function is inherently non-portable in the presence
* of plug-in platform modules as these need not correspond to the available
* types. To identify the graphics platform use
* mir_connection_get_graphics_module(). To safely interpret the
* buffer contents use mir_buffer_stream_get_graphics_region().
*
* \todo This should be removed from the public API at the next API break.
*
* \pre The stream is valid
* \param [in] stream The stream
* \return One of mir_platform_type_android or
* mir_platform_type_gbm
*/
__attribute__ ((deprecated))
MirPlatformType mir_buffer_stream_get_platform_type(MirBufferStream *stream);
/**
* Retrieve the current buffer in "raw" representation.
*
* // FIXME Waiting for a platform specific extension
*
* \pre The buffer stream is valid
* \param [in] buffer_stream The buffer stream
* \param [out] buffer_package Structure to be populated
*/
void mir_buffer_stream_get_current_buffer(MirBufferStream *buffer_stream,
MirNativeBuffer **buffer_package);
/**
* Advance a buffer stream's buffer. The returned handle remains valid until the
* next call to mir_buffer_stream_swap_buffers, until the buffer stream has been
* released or the connection to the server has been released.
* \warning callback could be called from another thread. You must do any
* locking appropriate to protect your data accessed in the
* callback.
* \param [in] buffer_stream The buffer stream
* \param [in] callback Callback function to be invoked when the request
* completes
* \param [in,out] context User data passed to the callback function
* \return A handle that can be passed to mir_wait_for
*/
MirWaitHandle *mir_buffer_stream_swap_buffers(
MirBufferStream *buffer_stream,
mir_buffer_stream_callback callback,
void *context);
/**
* Advance a buffer stream's buffer as in mir_buffer stream_swap_buffers(),
* but also wait for the operation to complete.
* \param [in] buffer_stream The buffer stream whose buffer to advance
*/
void mir_buffer_stream_swap_buffers_sync(MirBufferStream *buffer_stream);
/**
* Retrieve a buffer stream's graphics region
*
* \warning Depending on platform, this can map the graphics buffer each
* time its called. The region remains mapped until
* mir_buffer_stream_swap_buffers().
* \pre The buffer stream is valid
* \param [in] buffer_stream The buffer stream
* \param [out] graphics_region Structure to be populated
* \return True if the region is valid, false otherwise.
*/
bool mir_buffer_stream_get_graphics_region(
MirBufferStream *buffer_stream,
MirGraphicsRegion *graphics_region);
/**
* Retrieve a window type which may be used by EGL.
*
* // FIXME Waiting for MirRenderSurface* to then use directly with EGL
*
* \param [in] buffer_stream The buffer stream
* \return An EGLNativeWindowType that the client can use
*/
MirEGLNativeWindowType mir_buffer_stream_get_egl_native_window(MirBufferStream *buffer_stream);
/**
* Set the scale associated with all buffers in the stream
*
* \note May need deprecation - Need a consistent API for high DPI scaling/destination size
*
* \param [in] buffer_stream The buffer stream
* \param [in] scale The scale
* \return A handle that can be passed to mir_wait_for
*/
MirWaitHandle *mir_buffer_stream_set_scale(MirBufferStream* buffer_stream, float scale);
/**
* Set the scale as in mir_buffer_stream_set_scale(), but also wait for the
* operation to complete.
*
* \note May need deprecation - Need a consistent API for high DPI scaling/destination size
*
* \param [in] buffer_stream The buffer stream
* \param [in] scale The scale
*/
void mir_buffer_stream_set_scale_sync(MirBufferStream* buffer_stream, float scale);
/**
* Set the swapinterval for the stream.
* \warning EGL users should use eglSwapInterval directly.
* \warning Only swapinterval of 0 or 1 is supported.
* \param [in] stream The buffer stream
* \param [in] interval The number of vblank signals that
* mir_buffer_stream_swap_buffers will wait for
* \return A wait handle that can be passed to mir_wait_for,
* or NULL if the interval could not be supported
*/
MirWaitHandle* mir_buffer_stream_set_swapinterval(MirBufferStream* stream, int interval);
/**
* Query the swapinterval that the stream is operating with.
* The default interval is 1.
* \param [in] stream The buffer stream
* \return The swapinterval value that the client is operating with.
* Returns -1 if stream is invalid.
*/
int mir_buffer_stream_get_swapinterval(MirBufferStream* stream);
/**
* Set the physical size of the buffers provided by the buffer stream.
*
* \warning: This does not affect the size of the current buffer.
* The next buffer after calling mir_buffer_stream_swap_buffers
* will have the designated size.
*
* \param [in] stream The buffer stream
* \param [in] width The desired physical width
* \param [in] height The desired physical height
*/
void mir_buffer_stream_set_size(MirBufferStream* stream, int width, int height);
/**
* Get the physical size of the next buffer that will be provided by the stream.
*
* \param [in] stream The buffer stream
* \param [out] width The physical width of the stream
* \param [out] height The physical height of the stream
*/
void mir_buffer_stream_get_size(MirBufferStream* stream, int* width, int* height);
#ifdef __cplusplus
}
/**@}*/
#endif
#endif // MIR_TOOLKIT_MIR_BUFFER_STREAM_H_
|