Package org.lwjgl.vulkan

Class VkLatencySleepModeInfoNV

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkLatencySleepModeInfoNV>
org.lwjgl.vulkan.VkLatencySleepModeInfoNV
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkLatencySleepModeInfoNV extends org.lwjgl.system.Struct<VkLatencySleepModeInfoNV> implements org.lwjgl.system.NativeResource
Structure to set low latency mode.
Description

If lowLatencyMode is FALSE, lowLatencyBoost will still hint to the GPU to increase its power state and vkLatencySleepNV will still enforce minimumIntervalUs between vkQueuePresentKHR calls.

Valid Usage (Implicit)
See Also

SetLatencySleepModeNV

Layout


 struct VkLatencySleepModeInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkBool32 lowLatencyMode();
     VkBool32 lowLatencyBoost();
     uint32_t minimumIntervalUs();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • LOWLATENCYMODE

      public static final int LOWLATENCYMODE
      The struct member offsets.

    • LOWLATENCYBOOST

      public static final int LOWLATENCYBOOST
      The struct member offsets.

    • MINIMUMINTERVALUS

      public static final int MINIMUMINTERVALUS
      The struct member offsets.

  • Constructor Details

    • VkLatencySleepModeInfoNV

      public VkLatencySleepModeInfoNV(ByteBuffer container)
      Creates a VkLatencySleepModeInfoNV instance at the current position of the specified 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.

  • Method Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<VkLatencySleepModeInfoNV>

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

      public long pNext()
      NULL or a pointer to a structure extending this structure.

    • lowLatencyMode

      public boolean lowLatencyMode()
      the toggle to enable or disable low latency mode.

    • lowLatencyBoost

      public boolean lowLatencyBoost()
      allows an application to hint to the GPU to increase performance to provide additional latency savings at a cost of increased power consumption.

    • minimumIntervalUs

      public int minimumIntervalUs()
      the microseconds between QueuePresentKHR calls for a given swapchain that LatencySleepNV will enforce.

    • sType

      public VkLatencySleepModeInfoNV sType(int value)
      Sets the specified value to the sType() field.

    • sType$Default

      public VkLatencySleepModeInfoNV sType$Default()
      Sets the STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV value to the sType() field.

    • pNext

      public VkLatencySleepModeInfoNV pNext(long value)
      Sets the specified value to the pNext() field.

    • lowLatencyMode

      public VkLatencySleepModeInfoNV lowLatencyMode(boolean value)
      Sets the specified value to the lowLatencyMode() field.

    • lowLatencyBoost

      public VkLatencySleepModeInfoNV lowLatencyBoost(boolean value)
      Sets the specified value to the lowLatencyBoost() field.

    • minimumIntervalUs

      public VkLatencySleepModeInfoNV minimumIntervalUs(int value)
      Sets the specified value to the minimumIntervalUs() field.

    • set

      public VkLatencySleepModeInfoNV set(int sType, long pNext, boolean lowLatencyMode, boolean lowLatencyBoost, int minimumIntervalUs)
      Initializes this struct with the specified values.

    • set

      public VkLatencySleepModeInfoNV set(VkLatencySleepModeInfoNV src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static VkLatencySleepModeInfoNV malloc()
      Returns a new VkLatencySleepModeInfoNV instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static VkLatencySleepModeInfoNV calloc()
      Returns a new VkLatencySleepModeInfoNV instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static VkLatencySleepModeInfoNV create()
      Returns a new VkLatencySleepModeInfoNV instance allocated with BufferUtils.

    • create

      public static VkLatencySleepModeInfoNV create(long address)
      Returns a new VkLatencySleepModeInfoNV instance for the specified memory address.

    • createSafe

      public static @Nullable VkLatencySleepModeInfoNV createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkLatencySleepModeInfoNV.Buffer malloc(int capacity)
      Returns a new VkLatencySleepModeInfoNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkLatencySleepModeInfoNV.Buffer calloc(int capacity)
      Returns a new VkLatencySleepModeInfoNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkLatencySleepModeInfoNV.Buffer create(int capacity)
      Returns a new VkLatencySleepModeInfoNV.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkLatencySleepModeInfoNV.Buffer create(long address, int capacity)
      Create a VkLatencySleepModeInfoNV.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VkLatencySleepModeInfoNV.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkLatencySleepModeInfoNV malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkLatencySleepModeInfoNV instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static VkLatencySleepModeInfoNV calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkLatencySleepModeInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static VkLatencySleepModeInfoNV.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkLatencySleepModeInfoNV.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkLatencySleepModeInfoNV.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkLatencySleepModeInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • nsType

      public static int nsType(long struct)
      Unsafe version of sType().

    • npNext

      public static long npNext(long struct)
      Unsafe version of pNext().

    • nlowLatencyMode

      public static int nlowLatencyMode(long struct)
      Unsafe version of lowLatencyMode().

    • nlowLatencyBoost

      public static int nlowLatencyBoost(long struct)
      Unsafe version of lowLatencyBoost().

    • nminimumIntervalUs

      public static int nminimumIntervalUs(long struct)
      Unsafe version of minimumIntervalUs().

    • nsType

      public static void nsType(long struct, int value)
      Unsafe version of sType.

    • npNext

      public static void npNext(long struct, long value)
      Unsafe version of pNext.

    • nlowLatencyMode

      public static void nlowLatencyMode(long struct, int value)
      Unsafe version of lowLatencyMode.

    • nlowLatencyBoost

      public static void nlowLatencyBoost(long struct, int value)
      Unsafe version of lowLatencyBoost.

    • nminimumIntervalUs

      public static void nminimumIntervalUs(long struct, int value)
      Unsafe version of minimumIntervalUs.