org.lwjgl.vulkan.GOOGLEDisplayTiming Maven / Gradle / Ivy
Show all versions of lwjgl-vulkan Show documentation
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.JNI.*;
import static org.lwjgl.system.MemoryUtil.*;
/**
* This device extension allows an application that uses the {@link KHRSwapchain VK_KHR_swapchain} extension to obtain information about the presentation engine’s display, to obtain timing information about each present, and to schedule a present to happen no earlier than a desired time. An application can use this to minimize various visual anomalies (e.g. stuttering).
*
* Traditional game and real-time animation applications need to correctly position their geometry for when the presentable image will be presented to the user. To accomplish this, applications need various timing information about the presentation engine’s display. They need to know when presentable images were actually presented, and when they could have been presented. Applications also need to tell the presentation engine to display an image no sooner than a given time. This allows the application to avoid stuttering, so the animation looks smooth to the user.
*
* This extension treats variable-refresh-rate (VRR) displays as if they are fixed-refresh-rate (FRR) displays.
*
* Examples
*
* Note
*
* The example code for the this extension (like the {@link KHRSurface VK_KHR_surface} and {@code VK_GOOGLE_display_timing} extensions) is contained in the cube demo that is shipped with the official Khronos SDK, and is being kept up-to-date in that location (see: https://github.com/KhronosGroup/Vulkan-Tools/blob/master/cube/cube.c ).
*
*
* VK_GOOGLE_display_timing
*
*
* - Name String
* - {@code VK_GOOGLE_display_timing}
* - Extension Type
* - Device extension
* - Registered Extension Number
* - 93
* - Revision
* - 1
* - Extension and Version Dependencies
*
* - Requires Vulkan 1.0
* - Requires {@link KHRSwapchain VK_KHR_swapchain}
*
- Contact
*
* - Ian Elliott ianelliottus
*
*
* Other Extension Metadata
*
*
* - Last Modified Date
* - 2017-02-14
* - IP Status
* - No known IP claims.
* - Contributors
*
* - Ian Elliott, Google
* - Jesse Hall, Google
*
*/
public class GOOGLEDisplayTiming {
/** The extension specification version. */
public static final int VK_GOOGLE_DISPLAY_TIMING_SPEC_VERSION = 1;
/** The extension name. */
public static final String VK_GOOGLE_DISPLAY_TIMING_EXTENSION_NAME = "VK_GOOGLE_display_timing";
/** Extends {@code VkStructureType}. */
public static final int VK_STRUCTURE_TYPE_PRESENT_TIMES_INFO_GOOGLE = 1000092000;
protected GOOGLEDisplayTiming() {
throw new UnsupportedOperationException();
}
// --- [ vkGetRefreshCycleDurationGOOGLE ] ---
/** Unsafe version of: {@link #vkGetRefreshCycleDurationGOOGLE GetRefreshCycleDurationGOOGLE} */
public static int nvkGetRefreshCycleDurationGOOGLE(VkDevice device, long swapchain, long pDisplayTimingProperties) {
long __functionAddress = device.getCapabilities().vkGetRefreshCycleDurationGOOGLE;
if (CHECKS) {
check(__functionAddress);
}
return callPJPI(device.address(), swapchain, pDisplayTimingProperties, __functionAddress);
}
/**
* Obtain the RC duration of the PE’s display.
*
* C Specification
*
* To query the duration of a refresh cycle (RC) for the presentation engine’s display, call:
*
*
* VkResult vkGetRefreshCycleDurationGOOGLE(
* VkDevice device,
* VkSwapchainKHR swapchain,
* VkRefreshCycleDurationGOOGLE* pDisplayTimingProperties);
*
* Valid Usage (Implicit)
*
*
* - {@code device} must be a valid {@code VkDevice} handle
* - {@code swapchain} must be a valid {@code VkSwapchainKHR} handle
* - {@code pDisplayTimingProperties} must be a valid pointer to a {@link VkRefreshCycleDurationGOOGLE} structure
* - Both of {@code device}, and {@code swapchain} must have been created, allocated, or retrieved from the same {@code VkInstance}
*
*
* Host Synchronization
*
*
* - Host access to {@code swapchain} must be externally synchronized
*
*
* Return Codes
*
*
* - On success, this command returns
*
* - {@link VK10#VK_SUCCESS SUCCESS}
*
- On failure, this command returns
*
* - {@link VK10#VK_ERROR_OUT_OF_HOST_MEMORY ERROR_OUT_OF_HOST_MEMORY}
* - {@link VK10#VK_ERROR_DEVICE_LOST ERROR_DEVICE_LOST}
* - {@link KHRSurface#VK_ERROR_SURFACE_LOST_KHR ERROR_SURFACE_LOST_KHR}
*
*
* See Also
*
* {@link VkRefreshCycleDurationGOOGLE}
*
* @param device the device associated with {@code swapchain}.
* @param swapchain the swapchain to obtain the refresh duration for.
* @param pDisplayTimingProperties a pointer to a {@link VkRefreshCycleDurationGOOGLE} structure.
*/
@NativeType("VkResult")
public static int vkGetRefreshCycleDurationGOOGLE(VkDevice device, @NativeType("VkSwapchainKHR") long swapchain, @NativeType("VkRefreshCycleDurationGOOGLE *") VkRefreshCycleDurationGOOGLE pDisplayTimingProperties) {
return nvkGetRefreshCycleDurationGOOGLE(device, swapchain, pDisplayTimingProperties.address());
}
// --- [ vkGetPastPresentationTimingGOOGLE ] ---
/**
* Unsafe version of: {@link #vkGetPastPresentationTimingGOOGLE GetPastPresentationTimingGOOGLE}
*
* @param pPresentationTimingCount a pointer to an integer related to the number of {@link VkPastPresentationTimingGOOGLE} structures to query, as described below.
*/
public static int nvkGetPastPresentationTimingGOOGLE(VkDevice device, long swapchain, long pPresentationTimingCount, long pPresentationTimings) {
long __functionAddress = device.getCapabilities().vkGetPastPresentationTimingGOOGLE;
if (CHECKS) {
check(__functionAddress);
}
return callPJPPI(device.address(), swapchain, pPresentationTimingCount, pPresentationTimings, __functionAddress);
}
/**
* Obtain timing of a previously-presented image.
*
* C Specification
*
* The implementation will maintain a limited amount of history of timing information about previous presents. Because of the asynchronous nature of the presentation engine, the timing information for a given {@link KHRSwapchain#vkQueuePresentKHR QueuePresentKHR} command will become available some time later. These time values can be asynchronously queried, and will be returned if available. All time values are in nanoseconds, relative to a monotonically-increasing clock (e.g. {@code CLOCK_MONOTONIC} (see clock_gettime(2)) on Android and Linux).
*
* To asynchronously query the presentation engine, for newly-available timing information about one or more previous presents to a given swapchain, call:
*
*
* VkResult vkGetPastPresentationTimingGOOGLE(
* VkDevice device,
* VkSwapchainKHR swapchain,
* uint32_t* pPresentationTimingCount,
* VkPastPresentationTimingGOOGLE* pPresentationTimings);
*
* Description
*
* If {@code pPresentationTimings} is {@code NULL}, then the number of newly-available timing records for the given {@code swapchain} is returned in {@code pPresentationTimingCount}. Otherwise, {@code pPresentationTimingCount} must point to a variable set by the user to the number of elements in the {@code pPresentationTimings} array, and on return the variable is overwritten with the number of structures actually written to {@code pPresentationTimings}. If the value of {@code pPresentationTimingCount} is less than the number of newly-available timing records, at most {@code pPresentationTimingCount} structures will be written, and {@link VK10#VK_INCOMPLETE INCOMPLETE} will be returned instead of {@link VK10#VK_SUCCESS SUCCESS}, to indicate that not all the available timing records were returned.
*
* Valid Usage (Implicit)
*
*
* - {@code device} must be a valid {@code VkDevice} handle
* - {@code swapchain} must be a valid {@code VkSwapchainKHR} handle
* - {@code pPresentationTimingCount} must be a valid pointer to a {@code uint32_t} value
* - If the value referenced by {@code pPresentationTimingCount} is not 0, and {@code pPresentationTimings} is not {@code NULL}, {@code pPresentationTimings} must be a valid pointer to an array of {@code pPresentationTimingCount} {@link VkPastPresentationTimingGOOGLE} structures
* - Both of {@code device}, and {@code swapchain} must have been created, allocated, or retrieved from the same {@code VkInstance}
*
*
* Host Synchronization
*
*
* - Host access to {@code swapchain} must be externally synchronized
*
*
* Return Codes
*
*
* - On success, this command returns
*
* - {@link VK10#VK_SUCCESS SUCCESS}
* - {@link VK10#VK_INCOMPLETE INCOMPLETE}
*
- On failure, this command returns
*
* - {@link VK10#VK_ERROR_OUT_OF_HOST_MEMORY ERROR_OUT_OF_HOST_MEMORY}
* - {@link VK10#VK_ERROR_DEVICE_LOST ERROR_DEVICE_LOST}
* - {@link KHRSwapchain#VK_ERROR_OUT_OF_DATE_KHR ERROR_OUT_OF_DATE_KHR}
* - {@link KHRSurface#VK_ERROR_SURFACE_LOST_KHR ERROR_SURFACE_LOST_KHR}
*
*
* See Also
*
* {@link VkPastPresentationTimingGOOGLE}
*
* @param device the device associated with {@code swapchain}.
* @param swapchain the swapchain to obtain presentation timing information duration for.
* @param pPresentationTimingCount a pointer to an integer related to the number of {@link VkPastPresentationTimingGOOGLE} structures to query, as described below.
* @param pPresentationTimings either {@code NULL} or a pointer to an array of {@link VkPastPresentationTimingGOOGLE} structures.
*/
@NativeType("VkResult")
public static int vkGetPastPresentationTimingGOOGLE(VkDevice device, @NativeType("VkSwapchainKHR") long swapchain, @NativeType("uint32_t *") IntBuffer pPresentationTimingCount, @Nullable @NativeType("VkPastPresentationTimingGOOGLE *") VkPastPresentationTimingGOOGLE.Buffer pPresentationTimings) {
if (CHECKS) {
check(pPresentationTimingCount, 1);
checkSafe(pPresentationTimings, pPresentationTimingCount.get(pPresentationTimingCount.position()));
}
return nvkGetPastPresentationTimingGOOGLE(device, swapchain, memAddress(pPresentationTimingCount), memAddressSafe(pPresentationTimings));
}
/** Array version of: {@link #vkGetPastPresentationTimingGOOGLE GetPastPresentationTimingGOOGLE} */
@NativeType("VkResult")
public static int vkGetPastPresentationTimingGOOGLE(VkDevice device, @NativeType("VkSwapchainKHR") long swapchain, @NativeType("uint32_t *") int[] pPresentationTimingCount, @Nullable @NativeType("VkPastPresentationTimingGOOGLE *") VkPastPresentationTimingGOOGLE.Buffer pPresentationTimings) {
long __functionAddress = device.getCapabilities().vkGetPastPresentationTimingGOOGLE;
if (CHECKS) {
check(__functionAddress);
check(pPresentationTimingCount, 1);
checkSafe(pPresentationTimings, pPresentationTimingCount[0]);
}
return callPJPPI(device.address(), swapchain, pPresentationTimingCount, memAddressSafe(pPresentationTimings), __functionAddress);
}
}