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 {@link GOOGLEDisplayTiming#vkGetPastPresentationTimingGOOGLE GetPastPresentationTimingGOOGLE}.
*
* The application can use the fname: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}
*
* Member documentation
*
*
* - {@code presentID} – an application-provided value that was given to a previous {@link KHRSwapchain#vkQueuePresentKHR QueuePresentKHR} 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.
* - {@code desiredPresentTime} – 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}.
* - {@code actualPresentTime} – the time when the image of the {@code swapchain} was actually displayed.
* - {@code earliestPresentTime} – 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}.
* - {@code presentMargin} – an indication of how early the {@link KHRSwapchain#vkQueuePresentKHR QueuePresentKHR} command was processed compared to how soon it needed to be processed, and still be presented at {@code earliestPresentTime}.
*
*
* Layout
*
*
* struct VkPastPresentationTimingGOOGLE {
* uint32_t presentID;
* uint64_t desiredPresentTime;
* uint64_t actualPresentTime;
* uint64_t earliestPresentTime;
* uint64_t presentMargin;
* }The created instance holds a strong reference to the container object.
*/
public VkPastPresentationTimingGOOGLE(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code presentID} field. */
@NativeType("uint32_t")
public int presentID() { return npresentID(address()); }
/** Returns the value of the {@code desiredPresentTime} field. */
@NativeType("uint64_t")
public long desiredPresentTime() { return ndesiredPresentTime(address()); }
/** Returns the value of the {@code actualPresentTime} field. */
@NativeType("uint64_t")
public long actualPresentTime() { return nactualPresentTime(address()); }
/** Returns the value of the {@code earliestPresentTime} field. */
@NativeType("uint64_t")
public long earliestPresentTime() { return nearliestPresentTime(address()); }
/** Returns the value of the {@code presentMargin} field. */
@NativeType("uint64_t")
public long presentMargin() { return npresentMargin(address()); }
/** Sets the specified value to the {@code presentID} field. */
public VkPastPresentationTimingGOOGLE presentID(@NativeType("uint32_t") int value) { npresentID(address(), value); return this; }
/** Sets the specified value to the {@code desiredPresentTime} field. */
public VkPastPresentationTimingGOOGLE desiredPresentTime(@NativeType("uint64_t") long value) { ndesiredPresentTime(address(), value); return this; }
/** Sets the specified value to the {@code actualPresentTime} field. */
public VkPastPresentationTimingGOOGLE actualPresentTime(@NativeType("uint64_t") long value) { nactualPresentTime(address(), value); return this; }
/** Sets the specified value to the {@code earliestPresentTime} field. */
public VkPastPresentationTimingGOOGLE earliestPresentTime(@NativeType("uint64_t") long value) { nearliestPresentTime(address(), value); return this; }
/** Sets the specified value to the {@code presentMargin} field. */
public VkPastPresentationTimingGOOGLE presentMargin(@NativeType("uint64_t") long value) { npresentMargin(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkPastPresentationTimingGOOGLE set(
int presentID,
long desiredPresentTime,
long actualPresentTime,
long earliestPresentTime,
long presentMargin
) {
presentID(presentID);
desiredPresentTime(desiredPresentTime);
actualPresentTime(actualPresentTime);
earliestPresentTime(earliestPresentTime);
presentMargin(presentMargin);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkPastPresentationTimingGOOGLE set(VkPastPresentationTimingGOOGLE src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkPastPresentationTimingGOOGLE} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkPastPresentationTimingGOOGLE malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkPastPresentationTimingGOOGLE} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkPastPresentationTimingGOOGLE calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkPastPresentationTimingGOOGLE} instance allocated with {@link BufferUtils}. */
public static VkPastPresentationTimingGOOGLE create() {
return new VkPastPresentationTimingGOOGLE(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkPastPresentationTimingGOOGLE} instance for the specified memory address. */
public static VkPastPresentationTimingGOOGLE create(long address) {
return new VkPastPresentationTimingGOOGLE(address, null);
}
/** 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 : create(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 create(__malloc(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 create(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) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* 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 new Buffer(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 : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkPastPresentationTimingGOOGLE} instance allocated on the thread-local {@link MemoryStack}. */
public static VkPastPresentationTimingGOOGLE mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkPastPresentationTimingGOOGLE} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkPastPresentationTimingGOOGLE callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkPastPresentationTimingGOOGLE} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkPastPresentationTimingGOOGLE mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link 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 callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkPastPresentationTimingGOOGLE.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkPastPresentationTimingGOOGLE.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkPastPresentationTimingGOOGLE.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkPastPresentationTimingGOOGLE.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* 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 mallocStack(int capacity, MemoryStack stack) {
return create(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 callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #presentID}. */
public static int npresentID(long struct) { return memGetInt(struct + VkPastPresentationTimingGOOGLE.PRESENTID); }
/** Unsafe version of {@link #desiredPresentTime}. */
public static long ndesiredPresentTime(long struct) { return memGetLong(struct + VkPastPresentationTimingGOOGLE.DESIREDPRESENTTIME); }
/** Unsafe version of {@link #actualPresentTime}. */
public static long nactualPresentTime(long struct) { return memGetLong(struct + VkPastPresentationTimingGOOGLE.ACTUALPRESENTTIME); }
/** Unsafe version of {@link #earliestPresentTime}. */
public static long nearliestPresentTime(long struct) { return memGetLong(struct + VkPastPresentationTimingGOOGLE.EARLIESTPRESENTTIME); }
/** Unsafe version of {@link #presentMargin}. */
public static long npresentMargin(long struct) { return memGetLong(struct + VkPastPresentationTimingGOOGLE.PRESENTMARGIN); }
/** Unsafe version of {@link #presentID(int) presentID}. */
public static void npresentID(long struct, int value) { memPutInt(struct + VkPastPresentationTimingGOOGLE.PRESENTID, value); }
/** Unsafe version of {@link #desiredPresentTime(long) desiredPresentTime}. */
public static void ndesiredPresentTime(long struct, long value) { memPutLong(struct + VkPastPresentationTimingGOOGLE.DESIREDPRESENTTIME, value); }
/** Unsafe version of {@link #actualPresentTime(long) actualPresentTime}. */
public static void nactualPresentTime(long struct, long value) { memPutLong(struct + VkPastPresentationTimingGOOGLE.ACTUALPRESENTTIME, value); }
/** Unsafe version of {@link #earliestPresentTime(long) earliestPresentTime}. */
public static void nearliestPresentTime(long struct, long value) { memPutLong(struct + VkPastPresentationTimingGOOGLE.EARLIESTPRESENTTIME, value); }
/** Unsafe version of {@link #presentMargin(long) presentMargin}. */
public static void npresentMargin(long struct, long value) { memPutLong(struct + VkPastPresentationTimingGOOGLE.PRESENTMARGIN, value); }
// -----------------------------------
/** An array of {@link VkPastPresentationTimingGOOGLE} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link 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 Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkPastPresentationTimingGOOGLE newInstance(long address) {
return new VkPastPresentationTimingGOOGLE(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code presentID} field. */
@NativeType("uint32_t")
public int presentID() { return VkPastPresentationTimingGOOGLE.npresentID(address()); }
/** Returns the value of the {@code desiredPresentTime} field. */
@NativeType("uint64_t")
public long desiredPresentTime() { return VkPastPresentationTimingGOOGLE.ndesiredPresentTime(address()); }
/** Returns the value of the {@code actualPresentTime} field. */
@NativeType("uint64_t")
public long actualPresentTime() { return VkPastPresentationTimingGOOGLE.nactualPresentTime(address()); }
/** Returns the value of the {@code earliestPresentTime} field. */
@NativeType("uint64_t")
public long earliestPresentTime() { return VkPastPresentationTimingGOOGLE.nearliestPresentTime(address()); }
/** Returns the value of the {@code presentMargin} field. */
@NativeType("uint64_t")
public long presentMargin() { return VkPastPresentationTimingGOOGLE.npresentMargin(address()); }
/** Sets the specified value to the {@code presentID} field. */
public VkPastPresentationTimingGOOGLE.Buffer presentID(@NativeType("uint32_t") int value) { VkPastPresentationTimingGOOGLE.npresentID(address(), value); return this; }
/** Sets the specified value to the {@code desiredPresentTime} field. */
public VkPastPresentationTimingGOOGLE.Buffer desiredPresentTime(@NativeType("uint64_t") long value) { VkPastPresentationTimingGOOGLE.ndesiredPresentTime(address(), value); return this; }
/** Sets the specified value to the {@code actualPresentTime} field. */
public VkPastPresentationTimingGOOGLE.Buffer actualPresentTime(@NativeType("uint64_t") long value) { VkPastPresentationTimingGOOGLE.nactualPresentTime(address(), value); return this; }
/** Sets the specified value to the {@code earliestPresentTime} field. */
public VkPastPresentationTimingGOOGLE.Buffer earliestPresentTime(@NativeType("uint64_t") long value) { VkPastPresentationTimingGOOGLE.nearliestPresentTime(address(), value); return this; }
/** Sets the specified value to the {@code presentMargin} field. */
public VkPastPresentationTimingGOOGLE.Buffer presentMargin(@NativeType("uint64_t") long value) { VkPastPresentationTimingGOOGLE.npresentMargin(address(), value); return this; }
}
}