blob: 76564891bb2f8d59468016c8f59b6ffaa6a88d63 [file] [log] [blame]
Iliyan Malchev0ab886b2011-05-01 14:07:43 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef SYSTEM_CORE_INCLUDE_ANDROID_WINDOW_H
18#define SYSTEM_CORE_INCLUDE_ANDROID_WINDOW_H
19
20#include <stdint.h>
Mathias Agopianc958a7f2012-02-25 21:13:36 -080021#include <string.h>
Iliyan Malchev0ab886b2011-05-01 14:07:43 -070022#include <sys/cdefs.h>
23#include <system/graphics.h>
24#include <cutils/native_handle.h>
25
26__BEGIN_DECLS
27
28/*****************************************************************************/
29
30#define ANDROID_NATIVE_MAKE_CONSTANT(a,b,c,d) \
31 (((unsigned)(a)<<24)|((unsigned)(b)<<16)|((unsigned)(c)<<8)|(unsigned)(d))
32
33#define ANDROID_NATIVE_WINDOW_MAGIC \
34 ANDROID_NATIVE_MAKE_CONSTANT('_','w','n','d')
35
36#define ANDROID_NATIVE_BUFFER_MAGIC \
37 ANDROID_NATIVE_MAKE_CONSTANT('_','b','f','r')
38
39// ---------------------------------------------------------------------------
40
41typedef const native_handle_t* buffer_handle_t;
42
43// ---------------------------------------------------------------------------
44
45typedef struct android_native_rect_t
46{
47 int32_t left;
48 int32_t top;
49 int32_t right;
50 int32_t bottom;
51} android_native_rect_t;
52
53// ---------------------------------------------------------------------------
54
55typedef struct android_native_base_t
56{
57 /* a magic value defined by the actual EGL native type */
58 int magic;
59
60 /* the sizeof() of the actual EGL native type */
61 int version;
62
63 void* reserved[4];
64
65 /* reference-counting interface */
66 void (*incRef)(struct android_native_base_t* base);
67 void (*decRef)(struct android_native_base_t* base);
68} android_native_base_t;
69
70typedef struct ANativeWindowBuffer
71{
72#ifdef __cplusplus
73 ANativeWindowBuffer() {
74 common.magic = ANDROID_NATIVE_BUFFER_MAGIC;
75 common.version = sizeof(ANativeWindowBuffer);
76 memset(common.reserved, 0, sizeof(common.reserved));
77 }
78
79 // Implement the methods that sp<ANativeWindowBuffer> expects so that it
80 // can be used to automatically refcount ANativeWindowBuffer's.
81 void incStrong(const void* id) const {
82 common.incRef(const_cast<android_native_base_t*>(&common));
83 }
84 void decStrong(const void* id) const {
85 common.decRef(const_cast<android_native_base_t*>(&common));
86 }
87#endif
88
89 struct android_native_base_t common;
90
91 int width;
92 int height;
93 int stride;
94 int format;
95 int usage;
96
97 void* reserved[2];
98
99 buffer_handle_t handle;
100
101 void* reserved_proc[8];
102} ANativeWindowBuffer_t;
103
104// Old typedef for backwards compatibility.
105typedef ANativeWindowBuffer_t android_native_buffer_t;
106
107// ---------------------------------------------------------------------------
108
109/* attributes queriable with query() */
110enum {
111 NATIVE_WINDOW_WIDTH = 0,
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700112 NATIVE_WINDOW_HEIGHT = 1,
113 NATIVE_WINDOW_FORMAT = 2,
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700114
115 /* The minimum number of buffers that must remain un-dequeued after a buffer
116 * has been queued. This value applies only if set_buffer_count was used to
117 * override the number of buffers and if a buffer has since been queued.
118 * Users of the set_buffer_count ANativeWindow method should query this
119 * value before calling set_buffer_count. If it is necessary to have N
120 * buffers simultaneously dequeued as part of the steady-state operation,
121 * and this query returns M then N+M buffers should be requested via
122 * native_window_set_buffer_count.
123 *
124 * Note that this value does NOT apply until a single buffer has been
125 * queued. In particular this means that it is possible to:
126 *
127 * 1. Query M = min undequeued buffers
128 * 2. Set the buffer count to N + M
129 * 3. Dequeue all N + M buffers
130 * 4. Cancel M buffers
131 * 5. Queue, dequeue, queue, dequeue, ad infinitum
132 */
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700133 NATIVE_WINDOW_MIN_UNDEQUEUED_BUFFERS = 3,
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700134
135 /* Check whether queueBuffer operations on the ANativeWindow send the buffer
136 * to the window compositor. The query sets the returned 'value' argument
137 * to 1 if the ANativeWindow DOES send queued buffers directly to the window
138 * compositor and 0 if the buffers do not go directly to the window
139 * compositor.
140 *
141 * This can be used to determine whether protected buffer content should be
142 * sent to the ANativeWindow. Note, however, that a result of 1 does NOT
143 * indicate that queued buffers will be protected from applications or users
144 * capturing their contents. If that behavior is desired then some other
145 * mechanism (e.g. the GRALLOC_USAGE_PROTECTED flag) should be used in
146 * conjunction with this query.
147 */
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700148 NATIVE_WINDOW_QUEUES_TO_WINDOW_COMPOSER = 4,
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700149
150 /* Get the concrete type of a ANativeWindow. See below for the list of
151 * possible return values.
152 *
153 * This query should not be used outside the Android framework and will
154 * likely be removed in the near future.
155 */
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700156 NATIVE_WINDOW_CONCRETE_TYPE = 5,
Mathias Agopian51009162011-07-19 15:59:15 -0700157
158
159 /*
Michael I. Goldafcdef62012-04-09 18:21:13 -0700160 * Default width and height of ANativeWindow buffers, these are the
161 * dimensions of the window buffers irrespective of the
162 * NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS call and match the native window
163 * size unless overriden by NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS.
Mathias Agopian51009162011-07-19 15:59:15 -0700164 */
165 NATIVE_WINDOW_DEFAULT_WIDTH = 6,
166 NATIVE_WINDOW_DEFAULT_HEIGHT = 7,
167
168 /*
169 * transformation that will most-likely be applied to buffers. This is only
170 * a hint, the actual transformation applied might be different.
171 *
172 * INTENDED USE:
173 *
174 * The transform hint can be used by a producer, for instance the GLES
175 * driver, to pre-rotate the rendering such that the final transformation
176 * in the composer is identity. This can be very useful when used in
177 * conjunction with the h/w composer HAL, in situations where it
178 * cannot handle arbitrary rotations.
179 *
180 * 1. Before dequeuing a buffer, the GL driver (or any other ANW client)
181 * queries the ANW for NATIVE_WINDOW_TRANSFORM_HINT.
182 *
183 * 2. The GL driver overrides the width and height of the ANW to
184 * account for NATIVE_WINDOW_TRANSFORM_HINT. This is done by querying
185 * NATIVE_WINDOW_DEFAULT_{WIDTH | HEIGHT}, swapping the dimensions
186 * according to NATIVE_WINDOW_TRANSFORM_HINT and calling
187 * native_window_set_buffers_dimensions().
188 *
189 * 3. The GL driver dequeues a buffer of the new pre-rotated size.
190 *
191 * 4. The GL driver renders to the buffer such that the image is
192 * already transformed, that is applying NATIVE_WINDOW_TRANSFORM_HINT
193 * to the rendering.
194 *
195 * 5. The GL driver calls native_window_set_transform to apply
196 * inverse transformation to the buffer it just rendered.
197 * In order to do this, the GL driver needs
198 * to calculate the inverse of NATIVE_WINDOW_TRANSFORM_HINT, this is
199 * done easily:
200 *
201 * int hintTransform, inverseTransform;
202 * query(..., NATIVE_WINDOW_TRANSFORM_HINT, &hintTransform);
203 * inverseTransform = hintTransform;
204 * if (hintTransform & HAL_TRANSFORM_ROT_90)
205 * inverseTransform ^= HAL_TRANSFORM_ROT_180;
206 *
207 *
208 * 6. The GL driver queues the pre-transformed buffer.
209 *
210 * 7. The composer combines the buffer transform with the display
211 * transform. If the buffer transform happens to cancel out the
212 * display transform then no rotation is needed.
213 *
214 */
215 NATIVE_WINDOW_TRANSFORM_HINT = 8,
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700216};
217
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700218/* Valid operations for the (*perform)() hook.
219 *
220 * Values marked as 'deprecated' are supported, but have been superceded by
221 * other functionality.
222 *
223 * Values marked as 'private' should be considered private to the framework.
224 * HAL implementation code with access to an ANativeWindow should not use these,
225 * as it may not interact properly with the framework's use of the
226 * ANativeWindow.
227 */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700228enum {
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700229 NATIVE_WINDOW_SET_USAGE = 0,
Mathias Agopian8ad54522011-07-29 17:52:36 -0700230 NATIVE_WINDOW_CONNECT = 1, /* deprecated */
231 NATIVE_WINDOW_DISCONNECT = 2, /* deprecated */
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700232 NATIVE_WINDOW_SET_CROP = 3, /* private */
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700233 NATIVE_WINDOW_SET_BUFFER_COUNT = 4,
234 NATIVE_WINDOW_SET_BUFFERS_GEOMETRY = 5, /* deprecated */
235 NATIVE_WINDOW_SET_BUFFERS_TRANSFORM = 6,
236 NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP = 7,
237 NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS = 8,
238 NATIVE_WINDOW_SET_BUFFERS_FORMAT = 9,
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700239 NATIVE_WINDOW_SET_SCALING_MODE = 10, /* private */
Mathias Agopianae3736a2011-07-13 18:40:38 -0700240 NATIVE_WINDOW_LOCK = 11, /* private */
241 NATIVE_WINDOW_UNLOCK_AND_POST = 12, /* private */
Mathias Agopian8ad54522011-07-29 17:52:36 -0700242 NATIVE_WINDOW_API_CONNECT = 13, /* private */
243 NATIVE_WINDOW_API_DISCONNECT = 14, /* private */
Michael I. Goldafcdef62012-04-09 18:21:13 -0700244 NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS = 15, /* private */
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700245 NATIVE_WINDOW_SET_ACTIVE_RECT = 16, /* private */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700246};
247
Mathias Agopian8ad54522011-07-29 17:52:36 -0700248/* parameter for NATIVE_WINDOW_[API_][DIS]CONNECT */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700249enum {
Jamie Gennis5423e9e2011-07-12 13:53:42 -0700250 /* Buffers will be queued by EGL via eglSwapBuffers after being filled using
251 * OpenGL ES.
252 */
253 NATIVE_WINDOW_API_EGL = 1,
254
255 /* Buffers will be queued after being filled using the CPU
256 */
257 NATIVE_WINDOW_API_CPU = 2,
258
259 /* Buffers will be queued by Stagefright after being filled by a video
260 * decoder. The video decoder can either be a software or hardware decoder.
261 */
262 NATIVE_WINDOW_API_MEDIA = 3,
263
264 /* Buffers will be queued by the the camera HAL.
265 */
266 NATIVE_WINDOW_API_CAMERA = 4,
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700267};
268
269/* parameter for NATIVE_WINDOW_SET_BUFFERS_TRANSFORM */
270enum {
271 /* flip source image horizontally */
272 NATIVE_WINDOW_TRANSFORM_FLIP_H = HAL_TRANSFORM_FLIP_H ,
273 /* flip source image vertically */
274 NATIVE_WINDOW_TRANSFORM_FLIP_V = HAL_TRANSFORM_FLIP_V,
275 /* rotate source image 90 degrees clock-wise */
276 NATIVE_WINDOW_TRANSFORM_ROT_90 = HAL_TRANSFORM_ROT_90,
277 /* rotate source image 180 degrees */
278 NATIVE_WINDOW_TRANSFORM_ROT_180 = HAL_TRANSFORM_ROT_180,
279 /* rotate source image 270 degrees clock-wise */
280 NATIVE_WINDOW_TRANSFORM_ROT_270 = HAL_TRANSFORM_ROT_270,
281};
282
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700283/* parameter for NATIVE_WINDOW_SET_SCALING_MODE */
284enum {
285 /* the window content is not updated (frozen) until a buffer of
286 * the window size is received (enqueued)
287 */
288 NATIVE_WINDOW_SCALING_MODE_FREEZE = 0,
289 /* the buffer is scaled in both dimensions to match the window size */
290 NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW = 1,
Daniel Lam29392a42012-04-11 18:19:46 -0700291 /* the buffer is scaled uniformly such that the smaller dimension
292 * of the buffer matches the window size (cropping in the process)
293 */
294 NATIVE_WINDOW_SCALING_MODE_SCALE_CROP = 2,
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700295};
296
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700297/* values returned by the NATIVE_WINDOW_CONCRETE_TYPE query */
298enum {
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700299 NATIVE_WINDOW_FRAMEBUFFER = 0, /* FramebufferNativeWindow */
300 NATIVE_WINDOW_SURFACE = 1, /* Surface */
301 NATIVE_WINDOW_SURFACE_TEXTURE_CLIENT = 2, /* SurfaceTextureClient */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700302};
303
304/* parameter for NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP
305 *
306 * Special timestamp value to indicate that timestamps should be auto-generated
307 * by the native window when queueBuffer is called. This is equal to INT64_MIN,
308 * defined directly to avoid problems with C99/C++ inclusion of stdint.h.
309 */
310static const int64_t NATIVE_WINDOW_TIMESTAMP_AUTO = (-9223372036854775807LL-1);
311
312struct ANativeWindow
313{
314#ifdef __cplusplus
315 ANativeWindow()
316 : flags(0), minSwapInterval(0), maxSwapInterval(0), xdpi(0), ydpi(0)
317 {
318 common.magic = ANDROID_NATIVE_WINDOW_MAGIC;
319 common.version = sizeof(ANativeWindow);
320 memset(common.reserved, 0, sizeof(common.reserved));
321 }
322
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700323 /* Implement the methods that sp<ANativeWindow> expects so that it
324 can be used to automatically refcount ANativeWindow's. */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700325 void incStrong(const void* id) const {
326 common.incRef(const_cast<android_native_base_t*>(&common));
327 }
328 void decStrong(const void* id) const {
329 common.decRef(const_cast<android_native_base_t*>(&common));
330 }
331#endif
332
333 struct android_native_base_t common;
334
335 /* flags describing some attributes of this surface or its updater */
336 const uint32_t flags;
337
338 /* min swap interval supported by this updated */
339 const int minSwapInterval;
340
341 /* max swap interval supported by this updated */
342 const int maxSwapInterval;
343
344 /* horizontal and vertical resolution in DPI */
345 const float xdpi;
346 const float ydpi;
347
348 /* Some storage reserved for the OEM's driver. */
349 intptr_t oem[4];
350
351 /*
352 * Set the swap interval for this surface.
353 *
354 * Returns 0 on success or -errno on error.
355 */
356 int (*setSwapInterval)(struct ANativeWindow* window,
357 int interval);
358
359 /*
Jesse Hall7cd3e0a2011-12-12 10:32:55 -0800360 * Hook called by EGL to acquire a buffer. After this call, the buffer
361 * is not locked, so its content cannot be modified. This call may block if
362 * no buffers are available.
363 *
364 * The window holds a reference to the buffer between dequeueBuffer and
365 * either queueBuffer or cancelBuffer, so clients only need their own
366 * reference if they might use the buffer after queueing or canceling it.
367 * Holding a reference to a buffer after queueing or canceling it is only
368 * allowed if a specific buffer count has been set.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700369 *
370 * Returns 0 on success or -errno on error.
371 */
372 int (*dequeueBuffer)(struct ANativeWindow* window,
373 struct ANativeWindowBuffer** buffer);
374
375 /*
376 * hook called by EGL to lock a buffer. This MUST be called before modifying
377 * the content of a buffer. The buffer must have been acquired with
378 * dequeueBuffer first.
379 *
380 * Returns 0 on success or -errno on error.
381 */
382 int (*lockBuffer)(struct ANativeWindow* window,
383 struct ANativeWindowBuffer* buffer);
Jesse Hall7cd3e0a2011-12-12 10:32:55 -0800384 /*
385 * Hook called by EGL when modifications to the render buffer are done.
386 * This unlocks and post the buffer.
387 *
388 * The window holds a reference to the buffer between dequeueBuffer and
389 * either queueBuffer or cancelBuffer, so clients only need their own
390 * reference if they might use the buffer after queueing or canceling it.
391 * Holding a reference to a buffer after queueing or canceling it is only
392 * allowed if a specific buffer count has been set.
393 *
394 * Buffers MUST be queued in the same order than they were dequeued.
395 *
396 * Returns 0 on success or -errno on error.
397 */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700398 int (*queueBuffer)(struct ANativeWindow* window,
399 struct ANativeWindowBuffer* buffer);
400
401 /*
402 * hook used to retrieve information about the native window.
403 *
404 * Returns 0 on success or -errno on error.
405 */
406 int (*query)(const struct ANativeWindow* window,
407 int what, int* value);
408
409 /*
410 * hook used to perform various operations on the surface.
411 * (*perform)() is a generic mechanism to add functionality to
412 * ANativeWindow while keeping backward binary compatibility.
413 *
414 * DO NOT CALL THIS HOOK DIRECTLY. Instead, use the helper functions
415 * defined below.
416 *
417 * (*perform)() returns -ENOENT if the 'what' parameter is not supported
418 * by the surface's implementation.
419 *
420 * The valid operations are:
421 * NATIVE_WINDOW_SET_USAGE
Mathias Agopian8ad54522011-07-29 17:52:36 -0700422 * NATIVE_WINDOW_CONNECT (deprecated)
423 * NATIVE_WINDOW_DISCONNECT (deprecated)
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700424 * NATIVE_WINDOW_SET_CROP
425 * NATIVE_WINDOW_SET_BUFFER_COUNT
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700426 * NATIVE_WINDOW_SET_BUFFERS_GEOMETRY (deprecated)
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700427 * NATIVE_WINDOW_SET_BUFFERS_TRANSFORM
428 * NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700429 * NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS
430 * NATIVE_WINDOW_SET_BUFFERS_FORMAT
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700431 * NATIVE_WINDOW_SET_SCALING_MODE
Mathias Agopianae3736a2011-07-13 18:40:38 -0700432 * NATIVE_WINDOW_LOCK (private)
433 * NATIVE_WINDOW_UNLOCK_AND_POST (private)
Mathias Agopian8ad54522011-07-29 17:52:36 -0700434 * NATIVE_WINDOW_API_CONNECT (private)
435 * NATIVE_WINDOW_API_DISCONNECT (private)
Michael I. Goldafcdef62012-04-09 18:21:13 -0700436 * NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS (private)
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700437 *
438 */
439
440 int (*perform)(struct ANativeWindow* window,
441 int operation, ... );
442
443 /*
Jesse Hall7cd3e0a2011-12-12 10:32:55 -0800444 * Hook used to cancel a buffer that has been dequeued.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700445 * No synchronization is performed between dequeue() and cancel(), so
446 * either external synchronization is needed, or these functions must be
447 * called from the same thread.
Jesse Hall7cd3e0a2011-12-12 10:32:55 -0800448 *
449 * The window holds a reference to the buffer between dequeueBuffer and
450 * either queueBuffer or cancelBuffer, so clients only need their own
451 * reference if they might use the buffer after queueing or canceling it.
452 * Holding a reference to a buffer after queueing or canceling it is only
453 * allowed if a specific buffer count has been set.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700454 */
455 int (*cancelBuffer)(struct ANativeWindow* window,
456 struct ANativeWindowBuffer* buffer);
457
458
459 void* reserved_proc[2];
460};
461
462 /* Backwards compatibility: use ANativeWindow (struct ANativeWindow in C).
463 * android_native_window_t is deprecated.
464 */
465typedef struct ANativeWindow ANativeWindow;
466typedef struct ANativeWindow android_native_window_t;
467
468/*
469 * native_window_set_usage(..., usage)
470 * Sets the intended usage flags for the next buffers
471 * acquired with (*lockBuffer)() and on.
472 * By default (if this function is never called), a usage of
473 * GRALLOC_USAGE_HW_RENDER | GRALLOC_USAGE_HW_TEXTURE
474 * is assumed.
475 * Calling this function will usually cause following buffers to be
476 * reallocated.
477 */
478
479static inline int native_window_set_usage(
480 struct ANativeWindow* window, int usage)
481{
482 return window->perform(window, NATIVE_WINDOW_SET_USAGE, usage);
483}
484
Mathias Agopian8ad54522011-07-29 17:52:36 -0700485/* deprecated. Always returns 0. Don't call. */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700486static inline int native_window_connect(
Mathias Agopian8ad54522011-07-29 17:52:36 -0700487 struct ANativeWindow* window, int api) {
Mathias Agopian319f4e22011-08-03 11:26:38 -0700488 return 0;
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700489}
490
Mathias Agopian8ad54522011-07-29 17:52:36 -0700491/* deprecated. Always returns 0. Don't call. */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700492static inline int native_window_disconnect(
Mathias Agopian8ad54522011-07-29 17:52:36 -0700493 struct ANativeWindow* window, int api) {
Mathias Agopian319f4e22011-08-03 11:26:38 -0700494 return 0;
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700495}
496
497/*
498 * native_window_set_crop(..., crop)
499 * Sets which region of the next queued buffers needs to be considered.
500 * A buffer's crop region is scaled to match the surface's size.
501 *
502 * The specified crop region applies to all buffers queued after it is called.
503 *
504 * if 'crop' is NULL, subsequently queued buffers won't be cropped.
505 *
506 * An error is returned if for instance the crop region is invalid,
507 * out of the buffer's bound or if the window is invalid.
508 */
509static inline int native_window_set_crop(
510 struct ANativeWindow* window,
511 android_native_rect_t const * crop)
512{
513 return window->perform(window, NATIVE_WINDOW_SET_CROP, crop);
514}
515
516/*
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700517 * native_window_set_active_rect(..., active_rect)
518 * Sets the region of future queued buffers that are 'active'. Pixels outside
519 * this 'active' region are considered to be completely transparent regardless
520 * of the pixel values in the buffer. The active_rect argument specifies the
521 * active rectangle in buffer pixel coordinates.
522 *
523 * The specified active rectangle applies to all buffers queued after it is
524 * called.
525 *
526 * An error is returned if for instance the crop region is invalid,
527 * out of the buffer's bound or if the window is invalid.
528 */
529static inline int native_window_set_active_rect(
530 struct ANativeWindow* window,
531 android_native_rect_t const * active_rect)
532{
533 return window->perform(window, NATIVE_WINDOW_SET_ACTIVE_RECT, active_rect);
534}
535
536/*
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700537 * native_window_set_buffer_count(..., count)
538 * Sets the number of buffers associated with this native window.
539 */
540static inline int native_window_set_buffer_count(
541 struct ANativeWindow* window,
542 size_t bufferCount)
543{
544 return window->perform(window, NATIVE_WINDOW_SET_BUFFER_COUNT, bufferCount);
545}
546
547/*
548 * native_window_set_buffers_geometry(..., int w, int h, int format)
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700549 * All buffers dequeued after this call will have the dimensions and format
550 * specified. A successful call to this function has the same effect as calling
551 * native_window_set_buffers_size and native_window_set_buffers_format.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700552 *
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700553 * XXX: This function is deprecated. The native_window_set_buffers_dimensions
554 * and native_window_set_buffers_format functions should be used instead.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700555 */
556static inline int native_window_set_buffers_geometry(
557 struct ANativeWindow* window,
558 int w, int h, int format)
559{
560 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_GEOMETRY,
561 w, h, format);
562}
563
564/*
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700565 * native_window_set_buffers_dimensions(..., int w, int h)
566 * All buffers dequeued after this call will have the dimensions specified.
Michael I. Goldafcdef62012-04-09 18:21:13 -0700567 * In particular, all buffers will have a fixed-size, independent from the
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700568 * native-window size. They will be scaled according to the scaling mode
569 * (see native_window_set_scaling_mode) upon window composition.
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700570 *
571 * If w and h are 0, the normal behavior is restored. That is, dequeued buffers
572 * following this call will be sized to match the window's size.
573 *
574 * Calling this function will reset the window crop to a NULL value, which
575 * disables cropping of the buffers.
576 */
577static inline int native_window_set_buffers_dimensions(
578 struct ANativeWindow* window,
579 int w, int h)
580{
581 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS,
582 w, h);
583}
584
585/*
Michael I. Goldafcdef62012-04-09 18:21:13 -0700586 * native_window_set_buffers_user_dimensions(..., int w, int h)
587 *
588 * Sets the user buffer size for the window, which overrides the
589 * window's size. All buffers dequeued after this call will have the
590 * dimensions specified unless overridden by
591 * native_window_set_buffers_dimensions. All buffers will have a
592 * fixed-size, independent from the native-window size. They will be
593 * scaled according to the scaling mode (see
594 * native_window_set_scaling_mode) upon window composition.
595 *
596 * If w and h are 0, the normal behavior is restored. That is, the
597 * default buffer size will match the windows's size.
598 *
599 * Calling this function will reset the window crop to a NULL value, which
600 * disables cropping of the buffers.
601 */
602static inline int native_window_set_buffers_user_dimensions(
603 struct ANativeWindow* window,
604 int w, int h)
605{
606 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS,
607 w, h);
608}
609
610/*
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700611 * native_window_set_buffers_format(..., int format)
612 * All buffers dequeued after this call will have the format specified.
613 *
614 * If the specified format is 0, the default buffer format will be used.
615 */
616static inline int native_window_set_buffers_format(
617 struct ANativeWindow* window,
618 int format)
619{
620 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_FORMAT, format);
621}
622
623/*
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700624 * native_window_set_buffers_transform(..., int transform)
625 * All buffers queued after this call will be displayed transformed according
626 * to the transform parameter specified.
627 */
628static inline int native_window_set_buffers_transform(
629 struct ANativeWindow* window,
630 int transform)
631{
632 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_TRANSFORM,
633 transform);
634}
635
636/*
637 * native_window_set_buffers_timestamp(..., int64_t timestamp)
638 * All buffers queued after this call will be associated with the timestamp
639 * parameter specified. If the timestamp is set to NATIVE_WINDOW_TIMESTAMP_AUTO
640 * (the default), timestamps will be generated automatically when queueBuffer is
Glenn Kastenc322f672011-06-27 10:42:39 -0700641 * called. The timestamp is measured in nanoseconds, and is normally monotonically
642 * increasing. The timestamp should be unaffected by time-of-day adjustments,
643 * and for a camera should be strictly monotonic but for a media player may be
644 * reset when the position is set.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700645 */
646static inline int native_window_set_buffers_timestamp(
647 struct ANativeWindow* window,
648 int64_t timestamp)
649{
650 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP,
651 timestamp);
652}
653
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700654/*
655 * native_window_set_scaling_mode(..., int mode)
656 * All buffers queued after this call will be associated with the scaling mode
657 * specified.
658 */
659static inline int native_window_set_scaling_mode(
660 struct ANativeWindow* window,
661 int mode)
662{
663 return window->perform(window, NATIVE_WINDOW_SET_SCALING_MODE,
664 mode);
665}
666
Mathias Agopian8ad54522011-07-29 17:52:36 -0700667/*
668 * native_window_api_connect(..., int api)
669 * connects an API to this window. only one API can be connected at a time.
670 * Returns -EINVAL if for some reason the window cannot be connected, which
671 * can happen if it's connected to some other API.
672 */
673static inline int native_window_api_connect(
674 struct ANativeWindow* window, int api)
675{
Mathias Agopian319f4e22011-08-03 11:26:38 -0700676 return window->perform(window, NATIVE_WINDOW_API_CONNECT, api);
Mathias Agopian8ad54522011-07-29 17:52:36 -0700677}
678
679/*
680 * native_window_api_disconnect(..., int api)
681 * disconnect the API from this window.
682 * An error is returned if for instance the window wasn't connected in the
683 * first place.
684 */
685static inline int native_window_api_disconnect(
686 struct ANativeWindow* window, int api)
687{
Mathias Agopian319f4e22011-08-03 11:26:38 -0700688 return window->perform(window, NATIVE_WINDOW_API_DISCONNECT, api);
Mathias Agopian8ad54522011-07-29 17:52:36 -0700689}
690
691
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700692__END_DECLS
693
tedbo1ffdb382011-05-24 00:55:33 -0700694#endif /* SYSTEM_CORE_INCLUDE_ANDROID_WINDOW_H */