org.lwjgl.vulkan.VkPastPresentationTimingGOOGLE Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* 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.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure containing timing information about a previously-presented image.
*
* Description
*
* The results for a given {@code swapchain} and {@code presentID} are only returned once from {@code vkGetPastPresentationTimingGOOGLE}.
*
* The application can use the {@link VkPastPresentationTimingGOOGLE} values to occasionally adjust its timing. For example, if {@code actualPresentTime} is later than expected (e.g. one {@code refreshDuration} late), the application may increase its target IPD to a higher multiple of {@code refreshDuration} (e.g. decrease its frame rate from 60Hz to 30Hz). If {@code actualPresentTime} and {@code earliestPresentTime} are consistently different, and if {@code presentMargin} is consistently large enough, the application may decrease its target IPD to a smaller multiple of {@code refreshDuration} (e.g. increase its frame rate from 30Hz to 60Hz). If {@code actualPresentTime} and {@code earliestPresentTime} are same, and if {@code presentMargin} is consistently high, the application may delay the start of its input-render-present loop in order to decrease the latency between user input and the corresponding present (always leaving some margin in case a new image takes longer to render than the previous image). An application that desires its target IPD to always be the same as {@code refreshDuration}, can also adjust features until {@code actualPresentTime} is never late and {@code presentMargin} is satisfactory.
*
* See Also
*
* {@link GOOGLEDisplayTiming#vkGetPastPresentationTimingGOOGLE GetPastPresentationTimingGOOGLE}
*
* Layout
*
*
* struct VkPastPresentationTimingGOOGLE {
* uint32_t {@link #presentID};
* uint64_t {@link #desiredPresentTime};
* uint64_t {@link #actualPresentTime};
* uint64_t {@link #earliestPresentTime};
* uint64_t {@link #presentMargin};
* }
*/
public class VkPastPresentationTimingGOOGLE extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
PRESENTID,
DESIREDPRESENTTIME,
ACTUALPRESENTTIME,
EARLIESTPRESENTTIME,
PRESENTMARGIN;
static {
Layout layout = __struct(
__member(4),
__member(8),
__member(8),
__member(8),
__member(8)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
PRESENTID = layout.offsetof(0);
DESIREDPRESENTTIME = layout.offsetof(1);
ACTUALPRESENTTIME = layout.offsetof(2);
EARLIESTPRESENTTIME = layout.offsetof(3);
PRESENTMARGIN = layout.offsetof(4);
}
/**
* Creates a {@code VkPastPresentationTimingGOOGLE} instance at the current position of the specified {@link ByteBuffer} container. Changes to the buffer's content will be
* visible to the struct instance and vice versa.
*
* The created instance holds a strong reference to the container object.
*/
public VkPastPresentationTimingGOOGLE(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** an application-provided value that was given to a previous {@code vkQueuePresentKHR} command via {@link VkPresentTimeGOOGLE}{@code ::presentID} (see below). It can be used to uniquely identify a previous present with the {@link KHRSwapchain#vkQueuePresentKHR QueuePresentKHR} command. */
@NativeType("uint32_t")
public int presentID() { return npresentID(address()); }
/** an application-provided value that was given to a previous {@link KHRSwapchain#vkQueuePresentKHR QueuePresentKHR} command via {@link VkPresentTimeGOOGLE}{@code ::desiredPresentTime}. If non-zero, it was used by the application to indicate that an image not be presented any sooner than {@code desiredPresentTime}. */
@NativeType("uint64_t")
public long desiredPresentTime() { return ndesiredPresentTime(address()); }
/** the time when the image of the {@code swapchain} was actually displayed. */
@NativeType("uint64_t")
public long actualPresentTime() { return nactualPresentTime(address()); }
/** the time when the image of the {@code swapchain} could have been displayed. This may differ from {@code actualPresentTime} if the application requested that the image be presented no sooner than {@link VkPresentTimeGOOGLE}{@code ::desiredPresentTime}. */
@NativeType("uint64_t")
public long earliestPresentTime() { return nearliestPresentTime(address()); }
/** an indication of how early the {@code vkQueuePresentKHR} command was processed compared to how soon it needed to be processed, and still be presented at {@code earliestPresentTime}. */
@NativeType("uint64_t")
public long presentMargin() { return npresentMargin(address()); }
// -----------------------------------
/** Returns a new {@code VkPastPresentationTimingGOOGLE} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkPastPresentationTimingGOOGLE malloc() {
return wrap(VkPastPresentationTimingGOOGLE.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkPastPresentationTimingGOOGLE} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkPastPresentationTimingGOOGLE calloc() {
return wrap(VkPastPresentationTimingGOOGLE.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkPastPresentationTimingGOOGLE} instance allocated with {@link BufferUtils}. */
public static VkPastPresentationTimingGOOGLE create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkPastPresentationTimingGOOGLE.class, memAddress(container), container);
}
/** Returns a new {@code VkPastPresentationTimingGOOGLE} instance for the specified memory address. */
public static VkPastPresentationTimingGOOGLE create(long address) {
return wrap(VkPastPresentationTimingGOOGLE.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkPastPresentationTimingGOOGLE createSafe(long address) {
return address == NULL ? null : wrap(VkPastPresentationTimingGOOGLE.class, address);
}
/**
* Returns a new {@link VkPastPresentationTimingGOOGLE.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkPastPresentationTimingGOOGLE.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkPastPresentationTimingGOOGLE.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkPastPresentationTimingGOOGLE.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkPastPresentationTimingGOOGLE.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkPastPresentationTimingGOOGLE.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkPastPresentationTimingGOOGLE.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkPastPresentationTimingGOOGLE.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkPastPresentationTimingGOOGLE.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkPastPresentationTimingGOOGLE mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkPastPresentationTimingGOOGLE callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkPastPresentationTimingGOOGLE mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkPastPresentationTimingGOOGLE callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkPastPresentationTimingGOOGLE.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkPastPresentationTimingGOOGLE.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkPastPresentationTimingGOOGLE.Buffer mallocStack(int capacity, MemoryStack stack) { return malloc(capacity, stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkPastPresentationTimingGOOGLE.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code VkPastPresentationTimingGOOGLE} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkPastPresentationTimingGOOGLE malloc(MemoryStack stack) {
return wrap(VkPastPresentationTimingGOOGLE.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkPastPresentationTimingGOOGLE} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkPastPresentationTimingGOOGLE calloc(MemoryStack stack) {
return wrap(VkPastPresentationTimingGOOGLE.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkPastPresentationTimingGOOGLE.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkPastPresentationTimingGOOGLE.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkPastPresentationTimingGOOGLE.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkPastPresentationTimingGOOGLE.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #presentID}. */
public static int npresentID(long struct) { return UNSAFE.getInt(null, struct + VkPastPresentationTimingGOOGLE.PRESENTID); }
/** Unsafe version of {@link #desiredPresentTime}. */
public static long ndesiredPresentTime(long struct) { return UNSAFE.getLong(null, struct + VkPastPresentationTimingGOOGLE.DESIREDPRESENTTIME); }
/** Unsafe version of {@link #actualPresentTime}. */
public static long nactualPresentTime(long struct) { return UNSAFE.getLong(null, struct + VkPastPresentationTimingGOOGLE.ACTUALPRESENTTIME); }
/** Unsafe version of {@link #earliestPresentTime}. */
public static long nearliestPresentTime(long struct) { return UNSAFE.getLong(null, struct + VkPastPresentationTimingGOOGLE.EARLIESTPRESENTTIME); }
/** Unsafe version of {@link #presentMargin}. */
public static long npresentMargin(long struct) { return UNSAFE.getLong(null, struct + VkPastPresentationTimingGOOGLE.PRESENTMARGIN); }
// -----------------------------------
/** An array of {@link VkPastPresentationTimingGOOGLE} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkPastPresentationTimingGOOGLE ELEMENT_FACTORY = VkPastPresentationTimingGOOGLE.create(-1L);
/**
* Creates a new {@code VkPastPresentationTimingGOOGLE.Buffer} instance backed by the specified container.
*
* Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values
* will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided
* by {@link VkPastPresentationTimingGOOGLE#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected VkPastPresentationTimingGOOGLE getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link VkPastPresentationTimingGOOGLE#presentID} field. */
@NativeType("uint32_t")
public int presentID() { return VkPastPresentationTimingGOOGLE.npresentID(address()); }
/** @return the value of the {@link VkPastPresentationTimingGOOGLE#desiredPresentTime} field. */
@NativeType("uint64_t")
public long desiredPresentTime() { return VkPastPresentationTimingGOOGLE.ndesiredPresentTime(address()); }
/** @return the value of the {@link VkPastPresentationTimingGOOGLE#actualPresentTime} field. */
@NativeType("uint64_t")
public long actualPresentTime() { return VkPastPresentationTimingGOOGLE.nactualPresentTime(address()); }
/** @return the value of the {@link VkPastPresentationTimingGOOGLE#earliestPresentTime} field. */
@NativeType("uint64_t")
public long earliestPresentTime() { return VkPastPresentationTimingGOOGLE.nearliestPresentTime(address()); }
/** @return the value of the {@link VkPastPresentationTimingGOOGLE#presentMargin} field. */
@NativeType("uint64_t")
public long presentMargin() { return VkPastPresentationTimingGOOGLE.npresentMargin(address()); }
}
}