1f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright/* 2f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * Copyright (C) 2015 The Android Open Source Project 3f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * 4f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * Licensed under the Apache License, Version 2.0 (the "License"); 5f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * you may not use this file except in compliance with the License. 6f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * You may obtain a copy of the License at 7f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * 8f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * http://www.apache.org/licenses/LICENSE-2.0 9f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * 10f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * Unless required by applicable law or agreed to in writing, software 11f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * distributed under the License is distributed on an "AS IS" BASIS, 12f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * See the License for the specific language governing permissions and 14f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * limitations under the License. 15f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright */ 16f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright 17f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright/** 18f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * @addtogroup Choreographer 19f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * @{ 20f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright */ 21f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright 22f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright/** 23f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * @file choreographer.h 24f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright */ 25f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright 26f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright#ifndef ANDROID_CHOREOGRAPHER_H 27f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright#define ANDROID_CHOREOGRAPHER_H 28f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright 29fb911b2e44c739a8e5e47d0df54c96a790cf9aafMichael Wright#include <sys/cdefs.h> 30fb911b2e44c739a8e5e47d0df54c96a790cf9aafMichael Wright 31f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright__BEGIN_DECLS 32f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright 33494ed550f5aea1332984fb9f0f11036fc58bd716Dan Albert#if __ANDROID_API__ >= 24 34494ed550f5aea1332984fb9f0f11036fc58bd716Dan Albert 35f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wrightstruct AChoreographer; 36f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wrighttypedef struct AChoreographer AChoreographer; 37f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright 38f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright/** 39f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * Prototype of the function that is called when a new frame is being rendered. 40f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * It's passed the time that the frame is being rendered as nanoseconds in the 41f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * CLOCK_MONOTONIC time base, as well as the data pointer provided by the 42f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * application that registered a callback. All callbacks that run as part of 43f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * rendering a frame will observe the same frame time, so it should be used 44f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * whenever events need to be synchronized (e.g. animations). 45f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright */ 46f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wrighttypedef void (*AChoreographer_frameCallback)(long frameTimeNanos, void* data); 47f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright 48f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright/** 49f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * Get the AChoreographer instance for the current thread. This must be called 50f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * on an ALooper thread. 51f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright */ 52f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael WrightAChoreographer* AChoreographer_getInstance(); 53f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright 54f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright/** 55f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * Post a callback to be run on the next frame. The data pointer provided will 56f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * be passed to the callback function when it's called. 57f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright */ 58f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wrightvoid AChoreographer_postFrameCallback(AChoreographer* choreographer, 59f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright AChoreographer_frameCallback callback, void* data); 60f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright/** 61f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * Post a callback to be run on the frame following the specified delay. The 62f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * data pointer provided will be passed to the callback function when it's 63f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright * called. 64f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright */ 65f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wrightvoid AChoreographer_postFrameCallbackDelayed(AChoreographer* choreographer, 66f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright AChoreographer_frameCallback callback, void* data, long delayMillis); 67494ed550f5aea1332984fb9f0f11036fc58bd716Dan Albert 68494ed550f5aea1332984fb9f0f11036fc58bd716Dan Albert#endif /* __ANDROID_API__ >= 24 */ 69494ed550f5aea1332984fb9f0f11036fc58bd716Dan Albert 70f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright__END_DECLS 71f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright 72f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright#endif // ANDROID_CHOREOGRAPHER_H 73f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright 74f5eee40d7e36cdb3fc20ac023db4be8d85974bd9Michael Wright/** @} */ 75