Package org.lwjgl.vulkan

Class VkLatencySurfaceCapabilitiesNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkLatencySurfaceCapabilitiesNV>

org.lwjgl.vulkan.VkLatencySurfaceCapabilitiesNV

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkLatencySurfaceCapabilitiesNV
extends org.lwjgl.system.Struct<VkLatencySurfaceCapabilitiesNV>
implements org.lwjgl.system.NativeResource

Structure describing surface optimized presentation modes for use with low latency mode.

Description

If pPresentModes is NULL, then the number of present modes that are optimized for use with low latency mode returned in presentModeCount. Otherwise, presentModeCount must be set by the application to the number of elements in the pPresentModes array, and on return the variable is overwritten with the number of values actually written to pPresentModes. If the value of presentModeCount is less than the number of optimized present modes, at most presentModeCount values will be written to pPresentModes.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV
• If presentModeCount is not 0, and pPresentModes is not NULL, pPresentModes must be a valid pointer to an array of presentModeCount VkPresentModeKHR values

Layout

 struct VkLatencySurfaceCapabilitiesNV {
     VkStructureType sType();
     void const * pNext();
     uint32_t presentModeCount();
     VkPresentModeKHR * pPresentModes();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkLatencySurfaceCapabilitiesNV.Buffer	An array of VkLatencySurfaceCapabilitiesNV structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	PPRESENTMODES	The struct member offsets.
static final int	PRESENTMODECOUNT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkLatencySurfaceCapabilitiesNV(ByteBuffer container)	Creates a VkLatencySurfaceCapabilitiesNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkLatencySurfaceCapabilitiesNV	calloc()	Returns a new VkLatencySurfaceCapabilitiesNV instance allocated with memCalloc.
static VkLatencySurfaceCapabilitiesNV.Buffer	calloc(int capacity)	Returns a new VkLatencySurfaceCapabilitiesNV.Buffer instance allocated with memCalloc.
static VkLatencySurfaceCapabilitiesNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkLatencySurfaceCapabilitiesNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkLatencySurfaceCapabilitiesNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkLatencySurfaceCapabilitiesNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkLatencySurfaceCapabilitiesNV	create()	Returns a new VkLatencySurfaceCapabilitiesNV instance allocated with BufferUtils.
static VkLatencySurfaceCapabilitiesNV.Buffer	create(int capacity)	Returns a new VkLatencySurfaceCapabilitiesNV.Buffer instance allocated with BufferUtils.
static VkLatencySurfaceCapabilitiesNV	create(long address)	Returns a new VkLatencySurfaceCapabilitiesNV instance for the specified memory address.
static VkLatencySurfaceCapabilitiesNV.Buffer	create(long address, int capacity)	Create a VkLatencySurfaceCapabilitiesNV.Buffer instance at the specified memory.
static @Nullable VkLatencySurfaceCapabilitiesNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkLatencySurfaceCapabilitiesNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkLatencySurfaceCapabilitiesNV	malloc()	Returns a new VkLatencySurfaceCapabilitiesNV instance allocated with memAlloc.
static VkLatencySurfaceCapabilitiesNV.Buffer	malloc(int capacity)	Returns a new VkLatencySurfaceCapabilitiesNV.Buffer instance allocated with memAlloc.
static VkLatencySurfaceCapabilitiesNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkLatencySurfaceCapabilitiesNV.Buffer instance allocated on the specified MemoryStack.
static VkLatencySurfaceCapabilitiesNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkLatencySurfaceCapabilitiesNV instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable IntBuffer	npPresentModes(long struct)	Unsafe version of pPresentModes.
static void	npPresentModes(long struct, @Nullable IntBuffer value)	Unsafe version of pPresentModes.
static int	npresentModeCount(long struct)	Unsafe version of presentModeCount().
static void	npresentModeCount(long struct, int value)	Sets the specified value to the presentModeCount field of the specified struct.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkLatencySurfaceCapabilitiesNV	pNext(long value)	Sets the specified value to the pNext() field.
@Nullable IntBuffer	pPresentModes()	list of presentation modes optimized for use with low latency mode with presentModeCount entries.
VkLatencySurfaceCapabilitiesNV	pPresentModes(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pPresentModes() field.
int	presentModeCount()	the number of presentation modes provided.
VkLatencySurfaceCapabilitiesNV	presentModeCount(int value)	Sets the specified value to the presentModeCount() field.
VkLatencySurfaceCapabilitiesNV	set(int sType, long pNext, int presentModeCount, @Nullable IntBuffer pPresentModes)	Initializes this struct with the specified values.
VkLatencySurfaceCapabilitiesNV	set(VkLatencySurfaceCapabilitiesNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkLatencySurfaceCapabilitiesNV	sType(int value)	Sets the specified value to the sType() field.
VkLatencySurfaceCapabilitiesNV	sType$Default()	Sets the STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

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.

PRESENTMODECOUNT

public static final int PRESENTMODECOUNT

The struct member offsets.

PPRESENTMODES

public static final int PPRESENTMODES

The struct member offsets.

Constructor Details

VkLatencySurfaceCapabilitiesNV

public VkLatencySurfaceCapabilitiesNV(ByteBuffer container)

Creates a VkLatencySurfaceCapabilitiesNV 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<VkLatencySurfaceCapabilitiesNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

presentModeCount

public int presentModeCount()

the number of presentation modes provided.

pPresentModes

public @Nullable IntBuffer pPresentModes()

list of presentation modes optimized for use with low latency mode with presentModeCount entries.

sType

public VkLatencySurfaceCapabilitiesNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkLatencySurfaceCapabilitiesNV sType$Default()

Sets the STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV value to the sType() field.

pNext

public VkLatencySurfaceCapabilitiesNV pNext(long value)

Sets the specified value to the pNext() field.

presentModeCount

public VkLatencySurfaceCapabilitiesNV presentModeCount(int value)

Sets the specified value to the presentModeCount() field.

pPresentModes

public VkLatencySurfaceCapabilitiesNV pPresentModes(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pPresentModes() field.

set

public VkLatencySurfaceCapabilitiesNV set(int sType,
 long pNext,
 int presentModeCount,
 @Nullable IntBuffer pPresentModes)

Initializes this struct with the specified values.

set

public VkLatencySurfaceCapabilitiesNV set(VkLatencySurfaceCapabilitiesNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkLatencySurfaceCapabilitiesNV malloc()

Returns a new VkLatencySurfaceCapabilitiesNV instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkLatencySurfaceCapabilitiesNV calloc()

Returns a new VkLatencySurfaceCapabilitiesNV instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkLatencySurfaceCapabilitiesNV create()

Returns a new VkLatencySurfaceCapabilitiesNV instance allocated with BufferUtils.

create

public static VkLatencySurfaceCapabilitiesNV create(long address)

Returns a new VkLatencySurfaceCapabilitiesNV instance for the specified memory address.

createSafe

public static @Nullable VkLatencySurfaceCapabilitiesNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkLatencySurfaceCapabilitiesNV.Buffer malloc(int capacity)

Returns a new VkLatencySurfaceCapabilitiesNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkLatencySurfaceCapabilitiesNV.Buffer calloc(int capacity)

Returns a new VkLatencySurfaceCapabilitiesNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkLatencySurfaceCapabilitiesNV.Buffer create(int capacity)

Returns a new VkLatencySurfaceCapabilitiesNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkLatencySurfaceCapabilitiesNV.Buffer create(long address,
 int capacity)

Create a VkLatencySurfaceCapabilitiesNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkLatencySurfaceCapabilitiesNV.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkLatencySurfaceCapabilitiesNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkLatencySurfaceCapabilitiesNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkLatencySurfaceCapabilitiesNV calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkLatencySurfaceCapabilitiesNV instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkLatencySurfaceCapabilitiesNV.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkLatencySurfaceCapabilitiesNV.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkLatencySurfaceCapabilitiesNV.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkLatencySurfaceCapabilitiesNV.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().

npresentModeCount

public static int npresentModeCount(long struct)

Unsafe version of presentModeCount().

npPresentModes

public static @Nullable IntBuffer npPresentModes(long struct)

Unsafe version of pPresentModes.

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.

npresentModeCount

public static void npresentModeCount(long struct,
 int value)

Sets the specified value to the presentModeCount field of the specified struct.

npPresentModes

public static void npPresentModes(long struct,
 @Nullable IntBuffer value)

Unsafe version of pPresentModes.