Package org.lwjgl.vulkan

Class VkDisplaySurfaceStereoCreateInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDisplaySurfaceStereoCreateInfoNV>

org.lwjgl.vulkan.VkDisplaySurfaceStereoCreateInfoNV

All Implemented Interfaces:

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

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

Structure specifying stereo parameters of a newly created display plane surface object.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DISPLAY_SURFACE_STEREO_CREATE_INFO_NV
• stereoType must be a valid VkDisplaySurfaceStereoTypeNV value

Layout

 struct VkDisplaySurfaceStereoCreateInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkDisplaySurfaceStereoTypeNV stereoType();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDisplaySurfaceStereoCreateInfoNV.Buffer	An array of VkDisplaySurfaceStereoCreateInfoNV 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	SIZEOF	The struct size in bytes.
static final int	STEREOTYPE	The struct member offsets.
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
VkDisplaySurfaceStereoCreateInfoNV(ByteBuffer container)	Creates a VkDisplaySurfaceStereoCreateInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDisplaySurfaceStereoCreateInfoNV	calloc()	Returns a new VkDisplaySurfaceStereoCreateInfoNV instance allocated with memCalloc.
static VkDisplaySurfaceStereoCreateInfoNV.Buffer	calloc(int capacity)	Returns a new VkDisplaySurfaceStereoCreateInfoNV.Buffer instance allocated with memCalloc.
static VkDisplaySurfaceStereoCreateInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplaySurfaceStereoCreateInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplaySurfaceStereoCreateInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplaySurfaceStereoCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplaySurfaceStereoCreateInfoNV	create()	Returns a new VkDisplaySurfaceStereoCreateInfoNV instance allocated with BufferUtils.
static VkDisplaySurfaceStereoCreateInfoNV.Buffer	create(int capacity)	Returns a new VkDisplaySurfaceStereoCreateInfoNV.Buffer instance allocated with BufferUtils.
static VkDisplaySurfaceStereoCreateInfoNV	create(long address)	Returns a new VkDisplaySurfaceStereoCreateInfoNV instance for the specified memory address.
static VkDisplaySurfaceStereoCreateInfoNV.Buffer	create(long address, int capacity)	Create a VkDisplaySurfaceStereoCreateInfoNV.Buffer instance at the specified memory.
static @Nullable VkDisplaySurfaceStereoCreateInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDisplaySurfaceStereoCreateInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDisplaySurfaceStereoCreateInfoNV	malloc()	Returns a new VkDisplaySurfaceStereoCreateInfoNV instance allocated with memAlloc.
static VkDisplaySurfaceStereoCreateInfoNV.Buffer	malloc(int capacity)	Returns a new VkDisplaySurfaceStereoCreateInfoNV.Buffer instance allocated with memAlloc.
static VkDisplaySurfaceStereoCreateInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplaySurfaceStereoCreateInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkDisplaySurfaceStereoCreateInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplaySurfaceStereoCreateInfoNV 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 int	nstereoType(long struct)	Unsafe version of stereoType().
static void	nstereoType(long struct, int value)	Unsafe version of stereoType.
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.
VkDisplaySurfaceStereoCreateInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkDisplaySurfaceStereoCreateInfoNV	set(int sType, long pNext, int stereoType)	Initializes this struct with the specified values.
VkDisplaySurfaceStereoCreateInfoNV	set(VkDisplaySurfaceStereoCreateInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	stereoType()	a VkDisplaySurfaceStereoTypeNV value specifying the type of 3D stereo presentation the display will be configured for.
VkDisplaySurfaceStereoCreateInfoNV	stereoType(int value)	Sets the specified value to the stereoType() field.
int	sType()	a VkStructureType value identifying this structure.
VkDisplaySurfaceStereoCreateInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkDisplaySurfaceStereoCreateInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_DISPLAY_SURFACE_STEREO_CREATE_INFO_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.

STEREOTYPE

public static final int STEREOTYPE

The struct member offsets.

Constructor Details

VkDisplaySurfaceStereoCreateInfoNV

public VkDisplaySurfaceStereoCreateInfoNV(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

stereoType

public int stereoType()

a VkDisplaySurfaceStereoTypeNV value specifying the type of 3D stereo presentation the display will be configured for.

sType

public VkDisplaySurfaceStereoCreateInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDisplaySurfaceStereoCreateInfoNV sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_SURFACE_STEREO_CREATE_INFO_NV value to the sType() field.

pNext

public VkDisplaySurfaceStereoCreateInfoNV pNext(long value)

Sets the specified value to the pNext() field.

stereoType

public VkDisplaySurfaceStereoCreateInfoNV stereoType(int value)

Sets the specified value to the stereoType() field.

set

public VkDisplaySurfaceStereoCreateInfoNV set(int sType,
 long pNext,
 int stereoType)

Initializes this struct with the specified values.

set

public VkDisplaySurfaceStereoCreateInfoNV set(VkDisplaySurfaceStereoCreateInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDisplaySurfaceStereoCreateInfoNV malloc()

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

calloc

public static VkDisplaySurfaceStereoCreateInfoNV calloc()

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

create

public static VkDisplaySurfaceStereoCreateInfoNV create()

Returns a new VkDisplaySurfaceStereoCreateInfoNV instance allocated with BufferUtils.

create

public static VkDisplaySurfaceStereoCreateInfoNV create(long address)

Returns a new VkDisplaySurfaceStereoCreateInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkDisplaySurfaceStereoCreateInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDisplaySurfaceStereoCreateInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDisplaySurfaceStereoCreateInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDisplaySurfaceStereoCreateInfoNV.Buffer create(int capacity)

Returns a new VkDisplaySurfaceStereoCreateInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDisplaySurfaceStereoCreateInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkDisplaySurfaceStereoCreateInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nstereoType

public static int nstereoType(long struct)

Unsafe version of stereoType().

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.

nstereoType

public static void nstereoType(long struct,
 int value)

Unsafe version of stereoType.