2 * Copyright (C) 2011 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef SYSTEM_CORE_INCLUDE_ANDROID_WINDOW_H
18 #define SYSTEM_CORE_INCLUDE_ANDROID_WINDOW_H
20 #include <cutils/native_handle.h>
25 #include <sys/cdefs.h>
26 #include <system/graphics.h>
31 /*****************************************************************************/
33 #define ANDROID_NATIVE_MAKE_CONSTANT(a,b,c,d) \
34 (((unsigned)(a)<<24)|((unsigned)(b)<<16)|((unsigned)(c)<<8)|(unsigned)(d))
36 #define ANDROID_NATIVE_WINDOW_MAGIC \
37 ANDROID_NATIVE_MAKE_CONSTANT('_','w','n','d')
39 #define ANDROID_NATIVE_BUFFER_MAGIC \
40 ANDROID_NATIVE_MAKE_CONSTANT('_','b','f','r')
42 // ---------------------------------------------------------------------------
44 // This #define may be used to conditionally compile device-specific code to
45 // support either the prior ANativeWindow interface, which did not pass libsync
46 // fences around, or the new interface that does. This #define is only present
47 // when the ANativeWindow interface does include libsync support.
48 #define ANDROID_NATIVE_WINDOW_HAS_SYNC 1
50 // ---------------------------------------------------------------------------
52 typedef const native_handle_t
* buffer_handle_t
;
54 // ---------------------------------------------------------------------------
56 typedef struct android_native_rect_t
62 } android_native_rect_t
;
64 // ---------------------------------------------------------------------------
66 typedef struct android_native_base_t
68 /* a magic value defined by the actual EGL native type */
71 /* the sizeof() of the actual EGL native type */
76 /* reference-counting interface */
77 void (*incRef
)(struct android_native_base_t
* base
);
78 void (*decRef
)(struct android_native_base_t
* base
);
79 } android_native_base_t
;
81 typedef struct ANativeWindowBuffer
84 ANativeWindowBuffer() {
85 common
.magic
= ANDROID_NATIVE_BUFFER_MAGIC
;
86 common
.version
= sizeof(ANativeWindowBuffer
);
87 memset(common
.reserved
, 0, sizeof(common
.reserved
));
90 // Implement the methods that sp<ANativeWindowBuffer> expects so that it
91 // can be used to automatically refcount ANativeWindowBuffer's.
92 void incStrong(const void* id
) const {
93 common
.incRef(const_cast<android_native_base_t
*>(&common
));
95 void decStrong(const void* id
) const {
96 common
.decRef(const_cast<android_native_base_t
*>(&common
));
100 struct android_native_base_t common
;
110 buffer_handle_t handle
;
112 void* reserved_proc
[8];
113 } ANativeWindowBuffer_t
;
115 // Old typedef for backwards compatibility.
116 typedef ANativeWindowBuffer_t android_native_buffer_t
;
118 // ---------------------------------------------------------------------------
120 /* attributes queriable with query() */
122 NATIVE_WINDOW_WIDTH
= 0,
123 NATIVE_WINDOW_HEIGHT
= 1,
124 NATIVE_WINDOW_FORMAT
= 2,
126 /* The minimum number of buffers that must remain un-dequeued after a buffer
127 * has been queued. This value applies only if set_buffer_count was used to
128 * override the number of buffers and if a buffer has since been queued.
129 * Users of the set_buffer_count ANativeWindow method should query this
130 * value before calling set_buffer_count. If it is necessary to have N
131 * buffers simultaneously dequeued as part of the steady-state operation,
132 * and this query returns M then N+M buffers should be requested via
133 * native_window_set_buffer_count.
135 * Note that this value does NOT apply until a single buffer has been
136 * queued. In particular this means that it is possible to:
138 * 1. Query M = min undequeued buffers
139 * 2. Set the buffer count to N + M
140 * 3. Dequeue all N + M buffers
141 * 4. Cancel M buffers
142 * 5. Queue, dequeue, queue, dequeue, ad infinitum
144 NATIVE_WINDOW_MIN_UNDEQUEUED_BUFFERS
= 3,
146 /* Check whether queueBuffer operations on the ANativeWindow send the buffer
147 * to the window compositor. The query sets the returned 'value' argument
148 * to 1 if the ANativeWindow DOES send queued buffers directly to the window
149 * compositor and 0 if the buffers do not go directly to the window
152 * This can be used to determine whether protected buffer content should be
153 * sent to the ANativeWindow. Note, however, that a result of 1 does NOT
154 * indicate that queued buffers will be protected from applications or users
155 * capturing their contents. If that behavior is desired then some other
156 * mechanism (e.g. the GRALLOC_USAGE_PROTECTED flag) should be used in
157 * conjunction with this query.
159 NATIVE_WINDOW_QUEUES_TO_WINDOW_COMPOSER
= 4,
161 /* Get the concrete type of a ANativeWindow. See below for the list of
162 * possible return values.
164 * This query should not be used outside the Android framework and will
165 * likely be removed in the near future.
167 NATIVE_WINDOW_CONCRETE_TYPE
= 5,
171 * Default width and height of ANativeWindow buffers, these are the
172 * dimensions of the window buffers irrespective of the
173 * NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS call and match the native window
174 * size unless overridden by NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS.
176 NATIVE_WINDOW_DEFAULT_WIDTH
= 6,
177 NATIVE_WINDOW_DEFAULT_HEIGHT
= 7,
180 * transformation that will most-likely be applied to buffers. This is only
181 * a hint, the actual transformation applied might be different.
185 * The transform hint can be used by a producer, for instance the GLES
186 * driver, to pre-rotate the rendering such that the final transformation
187 * in the composer is identity. This can be very useful when used in
188 * conjunction with the h/w composer HAL, in situations where it
189 * cannot handle arbitrary rotations.
191 * 1. Before dequeuing a buffer, the GL driver (or any other ANW client)
192 * queries the ANW for NATIVE_WINDOW_TRANSFORM_HINT.
194 * 2. The GL driver overrides the width and height of the ANW to
195 * account for NATIVE_WINDOW_TRANSFORM_HINT. This is done by querying
196 * NATIVE_WINDOW_DEFAULT_{WIDTH | HEIGHT}, swapping the dimensions
197 * according to NATIVE_WINDOW_TRANSFORM_HINT and calling
198 * native_window_set_buffers_dimensions().
200 * 3. The GL driver dequeues a buffer of the new pre-rotated size.
202 * 4. The GL driver renders to the buffer such that the image is
203 * already transformed, that is applying NATIVE_WINDOW_TRANSFORM_HINT
206 * 5. The GL driver calls native_window_set_transform to apply
207 * inverse transformation to the buffer it just rendered.
208 * In order to do this, the GL driver needs
209 * to calculate the inverse of NATIVE_WINDOW_TRANSFORM_HINT, this is
212 * int hintTransform, inverseTransform;
213 * query(..., NATIVE_WINDOW_TRANSFORM_HINT, &hintTransform);
214 * inverseTransform = hintTransform;
215 * if (hintTransform & HAL_TRANSFORM_ROT_90)
216 * inverseTransform ^= HAL_TRANSFORM_ROT_180;
219 * 6. The GL driver queues the pre-transformed buffer.
221 * 7. The composer combines the buffer transform with the display
222 * transform. If the buffer transform happens to cancel out the
223 * display transform then no rotation is needed.
226 NATIVE_WINDOW_TRANSFORM_HINT
= 8,
229 * Boolean that indicates whether the consumer is running more than
230 * one buffer behind the producer.
232 NATIVE_WINDOW_CONSUMER_RUNNING_BEHIND
= 9,
235 * The consumer gralloc usage bits currently set by the consumer.
236 * The values are defined in hardware/libhardware/include/gralloc.h.
238 NATIVE_WINDOW_CONSUMER_USAGE_BITS
= 10
241 /* Valid operations for the (*perform)() hook.
243 * Values marked as 'deprecated' are supported, but have been superceded by
244 * other functionality.
246 * Values marked as 'private' should be considered private to the framework.
247 * HAL implementation code with access to an ANativeWindow should not use these,
248 * as it may not interact properly with the framework's use of the
252 NATIVE_WINDOW_SET_USAGE
= 0,
253 NATIVE_WINDOW_CONNECT
= 1, /* deprecated */
254 NATIVE_WINDOW_DISCONNECT
= 2, /* deprecated */
255 NATIVE_WINDOW_SET_CROP
= 3, /* private */
256 NATIVE_WINDOW_SET_BUFFER_COUNT
= 4,
257 NATIVE_WINDOW_SET_BUFFERS_GEOMETRY
= 5, /* deprecated */
258 NATIVE_WINDOW_SET_BUFFERS_TRANSFORM
= 6,
259 NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP
= 7,
260 NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS
= 8,
261 NATIVE_WINDOW_SET_BUFFERS_FORMAT
= 9,
262 NATIVE_WINDOW_SET_SCALING_MODE
= 10, /* private */
263 NATIVE_WINDOW_LOCK
= 11, /* private */
264 NATIVE_WINDOW_UNLOCK_AND_POST
= 12, /* private */
265 NATIVE_WINDOW_API_CONNECT
= 13, /* private */
266 NATIVE_WINDOW_API_DISCONNECT
= 14, /* private */
267 NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS
= 15, /* private */
268 NATIVE_WINDOW_SET_POST_TRANSFORM_CROP
= 16, /* private */
271 /* parameter for NATIVE_WINDOW_[API_][DIS]CONNECT */
273 /* Buffers will be queued by EGL via eglSwapBuffers after being filled using
276 NATIVE_WINDOW_API_EGL
= 1,
278 /* Buffers will be queued after being filled using the CPU
280 NATIVE_WINDOW_API_CPU
= 2,
282 /* Buffers will be queued by Stagefright after being filled by a video
283 * decoder. The video decoder can either be a software or hardware decoder.
285 NATIVE_WINDOW_API_MEDIA
= 3,
287 /* Buffers will be queued by the the camera HAL.
289 NATIVE_WINDOW_API_CAMERA
= 4,
292 /* parameter for NATIVE_WINDOW_SET_BUFFERS_TRANSFORM */
294 /* flip source image horizontally */
295 NATIVE_WINDOW_TRANSFORM_FLIP_H
= HAL_TRANSFORM_FLIP_H
,
296 /* flip source image vertically */
297 NATIVE_WINDOW_TRANSFORM_FLIP_V
= HAL_TRANSFORM_FLIP_V
,
298 /* rotate source image 90 degrees clock-wise, and is applied after TRANSFORM_FLIP_{H|V} */
299 NATIVE_WINDOW_TRANSFORM_ROT_90
= HAL_TRANSFORM_ROT_90
,
300 /* rotate source image 180 degrees */
301 NATIVE_WINDOW_TRANSFORM_ROT_180
= HAL_TRANSFORM_ROT_180
,
302 /* rotate source image 270 degrees clock-wise */
303 NATIVE_WINDOW_TRANSFORM_ROT_270
= HAL_TRANSFORM_ROT_270
,
304 /* transforms source by the inverse transform of the screen it is displayed onto. This
305 * transform is applied last */
306 NATIVE_WINDOW_TRANSFORM_INVERSE_DISPLAY
= 0x08
309 /* parameter for NATIVE_WINDOW_SET_SCALING_MODE */
311 /* the window content is not updated (frozen) until a buffer of
312 * the window size is received (enqueued)
314 NATIVE_WINDOW_SCALING_MODE_FREEZE
= 0,
315 /* the buffer is scaled in both dimensions to match the window size */
316 NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW
= 1,
317 /* the buffer is scaled uniformly such that the smaller dimension
318 * of the buffer matches the window size (cropping in the process)
320 NATIVE_WINDOW_SCALING_MODE_SCALE_CROP
= 2,
321 /* the window is clipped to the size of the buffer's crop rectangle; pixels
322 * outside the crop rectangle are treated as if they are completely
325 NATIVE_WINDOW_SCALING_MODE_NO_SCALE_CROP
= 3,
328 /* values returned by the NATIVE_WINDOW_CONCRETE_TYPE query */
330 NATIVE_WINDOW_FRAMEBUFFER
= 0, /* FramebufferNativeWindow */
331 NATIVE_WINDOW_SURFACE
= 1, /* Surface */
334 /* parameter for NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP
336 * Special timestamp value to indicate that timestamps should be auto-generated
337 * by the native window when queueBuffer is called. This is equal to INT64_MIN,
338 * defined directly to avoid problems with C99/C++ inclusion of stdint.h.
340 static const int64_t NATIVE_WINDOW_TIMESTAMP_AUTO
= (-9223372036854775807LL-1);
346 : flags(0), minSwapInterval(0), maxSwapInterval(0), xdpi(0), ydpi(0)
348 common
.magic
= ANDROID_NATIVE_WINDOW_MAGIC
;
349 common
.version
= sizeof(ANativeWindow
);
350 memset(common
.reserved
, 0, sizeof(common
.reserved
));
353 /* Implement the methods that sp<ANativeWindow> expects so that it
354 can be used to automatically refcount ANativeWindow's. */
355 void incStrong(const void* id
) const {
356 common
.incRef(const_cast<android_native_base_t
*>(&common
));
358 void decStrong(const void* id
) const {
359 common
.decRef(const_cast<android_native_base_t
*>(&common
));
363 struct android_native_base_t common
;
365 /* flags describing some attributes of this surface or its updater */
366 const uint32_t flags
;
368 /* min swap interval supported by this updated */
369 const int minSwapInterval
;
371 /* max swap interval supported by this updated */
372 const int maxSwapInterval
;
374 /* horizontal and vertical resolution in DPI */
378 /* Some storage reserved for the OEM's driver. */
382 * Set the swap interval for this surface.
384 * Returns 0 on success or -errno on error.
386 int (*setSwapInterval
)(struct ANativeWindow
* window
,
390 * Hook called by EGL to acquire a buffer. After this call, the buffer
391 * is not locked, so its content cannot be modified. This call may block if
392 * no buffers are available.
394 * The window holds a reference to the buffer between dequeueBuffer and
395 * either queueBuffer or cancelBuffer, so clients only need their own
396 * reference if they might use the buffer after queueing or canceling it.
397 * Holding a reference to a buffer after queueing or canceling it is only
398 * allowed if a specific buffer count has been set.
400 * Returns 0 on success or -errno on error.
402 * XXX: This function is deprecated. It will continue to work for some
403 * time for binary compatibility, but the new dequeueBuffer function that
404 * outputs a fence file descriptor should be used in its place.
406 int (*dequeueBuffer_DEPRECATED
)(struct ANativeWindow
* window
,
407 struct ANativeWindowBuffer
** buffer
);
410 * hook called by EGL to lock a buffer. This MUST be called before modifying
411 * the content of a buffer. The buffer must have been acquired with
412 * dequeueBuffer first.
414 * Returns 0 on success or -errno on error.
416 * XXX: This function is deprecated. It will continue to work for some
417 * time for binary compatibility, but it is essentially a no-op, and calls
418 * to it should be removed.
420 int (*lockBuffer_DEPRECATED
)(struct ANativeWindow
* window
,
421 struct ANativeWindowBuffer
* buffer
);
424 * Hook called by EGL when modifications to the render buffer are done.
425 * This unlocks and post the buffer.
427 * The window holds a reference to the buffer between dequeueBuffer and
428 * either queueBuffer or cancelBuffer, so clients only need their own
429 * reference if they might use the buffer after queueing or canceling it.
430 * Holding a reference to a buffer after queueing or canceling it is only
431 * allowed if a specific buffer count has been set.
433 * Buffers MUST be queued in the same order than they were dequeued.
435 * Returns 0 on success or -errno on error.
437 * XXX: This function is deprecated. It will continue to work for some
438 * time for binary compatibility, but the new queueBuffer function that
439 * takes a fence file descriptor should be used in its place (pass a value
440 * of -1 for the fence file descriptor if there is no valid one to pass).
442 int (*queueBuffer_DEPRECATED
)(struct ANativeWindow
* window
,
443 struct ANativeWindowBuffer
* buffer
);
446 * hook used to retrieve information about the native window.
448 * Returns 0 on success or -errno on error.
450 int (*query
)(const struct ANativeWindow
* window
,
451 int what
, int* value
);
454 * hook used to perform various operations on the surface.
455 * (*perform)() is a generic mechanism to add functionality to
456 * ANativeWindow while keeping backward binary compatibility.
458 * DO NOT CALL THIS HOOK DIRECTLY. Instead, use the helper functions
461 * (*perform)() returns -ENOENT if the 'what' parameter is not supported
462 * by the surface's implementation.
464 * The valid operations are:
465 * NATIVE_WINDOW_SET_USAGE
466 * NATIVE_WINDOW_CONNECT (deprecated)
467 * NATIVE_WINDOW_DISCONNECT (deprecated)
468 * NATIVE_WINDOW_SET_CROP (private)
469 * NATIVE_WINDOW_SET_BUFFER_COUNT
470 * NATIVE_WINDOW_SET_BUFFERS_GEOMETRY (deprecated)
471 * NATIVE_WINDOW_SET_BUFFERS_TRANSFORM
472 * NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP
473 * NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS
474 * NATIVE_WINDOW_SET_BUFFERS_FORMAT
475 * NATIVE_WINDOW_SET_SCALING_MODE (private)
476 * NATIVE_WINDOW_LOCK (private)
477 * NATIVE_WINDOW_UNLOCK_AND_POST (private)
478 * NATIVE_WINDOW_API_CONNECT (private)
479 * NATIVE_WINDOW_API_DISCONNECT (private)
480 * NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS (private)
481 * NATIVE_WINDOW_SET_POST_TRANSFORM_CROP (private)
485 int (*perform
)(struct ANativeWindow
* window
,
486 int operation
, ... );
489 * Hook used to cancel a buffer that has been dequeued.
490 * No synchronization is performed between dequeue() and cancel(), so
491 * either external synchronization is needed, or these functions must be
492 * called from the same thread.
494 * The window holds a reference to the buffer between dequeueBuffer and
495 * either queueBuffer or cancelBuffer, so clients only need their own
496 * reference if they might use the buffer after queueing or canceling it.
497 * Holding a reference to a buffer after queueing or canceling it is only
498 * allowed if a specific buffer count has been set.
500 * XXX: This function is deprecated. It will continue to work for some
501 * time for binary compatibility, but the new cancelBuffer function that
502 * takes a fence file descriptor should be used in its place (pass a value
503 * of -1 for the fence file descriptor if there is no valid one to pass).
505 int (*cancelBuffer_DEPRECATED
)(struct ANativeWindow
* window
,
506 struct ANativeWindowBuffer
* buffer
);
509 * Hook called by EGL to acquire a buffer. This call may block if no
510 * buffers are available.
512 * The window holds a reference to the buffer between dequeueBuffer and
513 * either queueBuffer or cancelBuffer, so clients only need their own
514 * reference if they might use the buffer after queueing or canceling it.
515 * Holding a reference to a buffer after queueing or canceling it is only
516 * allowed if a specific buffer count has been set.
518 * The libsync fence file descriptor returned in the int pointed to by the
519 * fenceFd argument will refer to the fence that must signal before the
520 * dequeued buffer may be written to. A value of -1 indicates that the
521 * caller may access the buffer immediately without waiting on a fence. If
522 * a valid file descriptor is returned (i.e. any value except -1) then the
523 * caller is responsible for closing the file descriptor.
525 * Returns 0 on success or -errno on error.
527 int (*dequeueBuffer
)(struct ANativeWindow
* window
,
528 struct ANativeWindowBuffer
** buffer
, int* fenceFd
);
531 * Hook called by EGL when modifications to the render buffer are done.
532 * This unlocks and post the buffer.
534 * The window holds a reference to the buffer between dequeueBuffer and
535 * either queueBuffer or cancelBuffer, so clients only need their own
536 * reference if they might use the buffer after queueing or canceling it.
537 * Holding a reference to a buffer after queueing or canceling it is only
538 * allowed if a specific buffer count has been set.
540 * The fenceFd argument specifies a libsync fence file descriptor for a
541 * fence that must signal before the buffer can be accessed. If the buffer
542 * can be accessed immediately then a value of -1 should be used. The
543 * caller must not use the file descriptor after it is passed to
544 * queueBuffer, and the ANativeWindow implementation is responsible for
547 * Returns 0 on success or -errno on error.
549 int (*queueBuffer
)(struct ANativeWindow
* window
,
550 struct ANativeWindowBuffer
* buffer
, int fenceFd
);
553 * Hook used to cancel a buffer that has been dequeued.
554 * No synchronization is performed between dequeue() and cancel(), so
555 * either external synchronization is needed, or these functions must be
556 * called from the same thread.
558 * The window holds a reference to the buffer between dequeueBuffer and
559 * either queueBuffer or cancelBuffer, so clients only need their own
560 * reference if they might use the buffer after queueing or canceling it.
561 * Holding a reference to a buffer after queueing or canceling it is only
562 * allowed if a specific buffer count has been set.
564 * The fenceFd argument specifies a libsync fence file decsriptor for a
565 * fence that must signal before the buffer can be accessed. If the buffer
566 * can be accessed immediately then a value of -1 should be used.
568 * Note that if the client has not waited on the fence that was returned
569 * from dequeueBuffer, that same fence should be passed to cancelBuffer to
570 * ensure that future uses of the buffer are preceded by a wait on that
571 * fence. The caller must not use the file descriptor after it is passed
572 * to cancelBuffer, and the ANativeWindow implementation is responsible for
575 * Returns 0 on success or -errno on error.
577 int (*cancelBuffer
)(struct ANativeWindow
* window
,
578 struct ANativeWindowBuffer
* buffer
, int fenceFd
);
581 /* Backwards compatibility: use ANativeWindow (struct ANativeWindow in C).
582 * android_native_window_t is deprecated.
584 typedef struct ANativeWindow ANativeWindow
;
585 typedef struct ANativeWindow android_native_window_t
;
588 * native_window_set_usage(..., usage)
589 * Sets the intended usage flags for the next buffers
590 * acquired with (*lockBuffer)() and on.
591 * By default (if this function is never called), a usage of
592 * GRALLOC_USAGE_HW_RENDER | GRALLOC_USAGE_HW_TEXTURE
594 * Calling this function will usually cause following buffers to be
598 static inline int native_window_set_usage(
599 struct ANativeWindow
* window
, int usage
)
601 return window
->perform(window
, NATIVE_WINDOW_SET_USAGE
, usage
);
604 /* deprecated. Always returns 0. Don't call. */
605 static inline int native_window_connect(
606 struct ANativeWindow
* window
, int api
) {
610 /* deprecated. Always returns 0. Don't call. */
611 static inline int native_window_disconnect(
612 struct ANativeWindow
* window
, int api
) {
617 * native_window_set_crop(..., crop)
618 * Sets which region of the next queued buffers needs to be considered.
619 * Depending on the scaling mode, a buffer's crop region is scaled and/or
620 * cropped to match the surface's size. This function sets the crop in
621 * pre-transformed buffer pixel coordinates.
623 * The specified crop region applies to all buffers queued after it is called.
625 * If 'crop' is NULL, subsequently queued buffers won't be cropped.
627 * An error is returned if for instance the crop region is invalid, out of the
628 * buffer's bound or if the window is invalid.
630 static inline int native_window_set_crop(
631 struct ANativeWindow
* window
,
632 android_native_rect_t
const * crop
)
634 return window
->perform(window
, NATIVE_WINDOW_SET_CROP
, crop
);
638 * native_window_set_post_transform_crop(..., crop)
639 * Sets which region of the next queued buffers needs to be considered.
640 * Depending on the scaling mode, a buffer's crop region is scaled and/or
641 * cropped to match the surface's size. This function sets the crop in
642 * post-transformed pixel coordinates.
644 * The specified crop region applies to all buffers queued after it is called.
646 * If 'crop' is NULL, subsequently queued buffers won't be cropped.
648 * An error is returned if for instance the crop region is invalid, out of the
649 * buffer's bound or if the window is invalid.
651 static inline int native_window_set_post_transform_crop(
652 struct ANativeWindow
* window
,
653 android_native_rect_t
const * crop
)
655 return window
->perform(window
, NATIVE_WINDOW_SET_POST_TRANSFORM_CROP
, crop
);
659 * native_window_set_active_rect(..., active_rect)
661 * This function is deprecated and will be removed soon. For now it simply
662 * sets the post-transform crop for compatibility while multi-project commits
665 static inline int native_window_set_active_rect(
666 struct ANativeWindow
* window
,
667 android_native_rect_t
const * active_rect
)
669 return native_window_set_post_transform_crop(window
, active_rect
);
673 * native_window_set_buffer_count(..., count)
674 * Sets the number of buffers associated with this native window.
676 static inline int native_window_set_buffer_count(
677 struct ANativeWindow
* window
,
680 return window
->perform(window
, NATIVE_WINDOW_SET_BUFFER_COUNT
, bufferCount
);
684 * native_window_set_buffers_geometry(..., int w, int h, int format)
685 * All buffers dequeued after this call will have the dimensions and format
686 * specified. A successful call to this function has the same effect as calling
687 * native_window_set_buffers_size and native_window_set_buffers_format.
689 * XXX: This function is deprecated. The native_window_set_buffers_dimensions
690 * and native_window_set_buffers_format functions should be used instead.
692 static inline int native_window_set_buffers_geometry(
693 struct ANativeWindow
* window
,
694 int w
, int h
, int format
)
696 return window
->perform(window
, NATIVE_WINDOW_SET_BUFFERS_GEOMETRY
,
701 * native_window_set_buffers_dimensions(..., int w, int h)
702 * All buffers dequeued after this call will have the dimensions specified.
703 * In particular, all buffers will have a fixed-size, independent from the
704 * native-window size. They will be scaled according to the scaling mode
705 * (see native_window_set_scaling_mode) upon window composition.
707 * If w and h are 0, the normal behavior is restored. That is, dequeued buffers
708 * following this call will be sized to match the window's size.
710 * Calling this function will reset the window crop to a NULL value, which
711 * disables cropping of the buffers.
713 static inline int native_window_set_buffers_dimensions(
714 struct ANativeWindow
* window
,
717 return window
->perform(window
, NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS
,
722 * native_window_set_buffers_user_dimensions(..., int w, int h)
724 * Sets the user buffer size for the window, which overrides the
725 * window's size. All buffers dequeued after this call will have the
726 * dimensions specified unless overridden by
727 * native_window_set_buffers_dimensions. All buffers will have a
728 * fixed-size, independent from the native-window size. They will be
729 * scaled according to the scaling mode (see
730 * native_window_set_scaling_mode) upon window composition.
732 * If w and h are 0, the normal behavior is restored. That is, the
733 * default buffer size will match the windows's size.
735 * Calling this function will reset the window crop to a NULL value, which
736 * disables cropping of the buffers.
738 static inline int native_window_set_buffers_user_dimensions(
739 struct ANativeWindow
* window
,
742 return window
->perform(window
, NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS
,
747 * native_window_set_buffers_format(..., int format)
748 * All buffers dequeued after this call will have the format specified.
750 * If the specified format is 0, the default buffer format will be used.
752 static inline int native_window_set_buffers_format(
753 struct ANativeWindow
* window
,
756 return window
->perform(window
, NATIVE_WINDOW_SET_BUFFERS_FORMAT
, format
);
760 * native_window_set_buffers_transform(..., int transform)
761 * All buffers queued after this call will be displayed transformed according
762 * to the transform parameter specified.
764 static inline int native_window_set_buffers_transform(
765 struct ANativeWindow
* window
,
768 return window
->perform(window
, NATIVE_WINDOW_SET_BUFFERS_TRANSFORM
,
773 * native_window_set_buffers_timestamp(..., int64_t timestamp)
774 * All buffers queued after this call will be associated with the timestamp
775 * parameter specified. If the timestamp is set to NATIVE_WINDOW_TIMESTAMP_AUTO
776 * (the default), timestamps will be generated automatically when queueBuffer is
777 * called. The timestamp is measured in nanoseconds, and is normally monotonically
778 * increasing. The timestamp should be unaffected by time-of-day adjustments,
779 * and for a camera should be strictly monotonic but for a media player may be
780 * reset when the position is set.
782 static inline int native_window_set_buffers_timestamp(
783 struct ANativeWindow
* window
,
786 return window
->perform(window
, NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP
,
791 * native_window_set_scaling_mode(..., int mode)
792 * All buffers queued after this call will be associated with the scaling mode
795 static inline int native_window_set_scaling_mode(
796 struct ANativeWindow
* window
,
799 return window
->perform(window
, NATIVE_WINDOW_SET_SCALING_MODE
,
804 * native_window_api_connect(..., int api)
805 * connects an API to this window. only one API can be connected at a time.
806 * Returns -EINVAL if for some reason the window cannot be connected, which
807 * can happen if it's connected to some other API.
809 static inline int native_window_api_connect(
810 struct ANativeWindow
* window
, int api
)
812 return window
->perform(window
, NATIVE_WINDOW_API_CONNECT
, api
);
816 * native_window_api_disconnect(..., int api)
817 * disconnect the API from this window.
818 * An error is returned if for instance the window wasn't connected in the
821 static inline int native_window_api_disconnect(
822 struct ANativeWindow
* window
, int api
)
824 return window
->perform(window
, NATIVE_WINDOW_API_DISCONNECT
, api
);
828 * native_window_dequeue_buffer_and_wait(...)
829 * Dequeue a buffer and wait on the fence associated with that buffer. The
830 * buffer may safely be accessed immediately upon this function returning. An
831 * error is returned if either of the dequeue or the wait operations fail.
833 static inline int native_window_dequeue_buffer_and_wait(ANativeWindow
*anw
,
834 struct ANativeWindowBuffer
** anb
) {
835 return anw
->dequeueBuffer_DEPRECATED(anw
, anb
);
841 #endif /* SYSTEM_CORE_INCLUDE_ANDROID_WINDOW_H */