Package org.lwjgl.vulkan

Class VkDisplayPlaneProperties2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDisplayPlaneProperties2KHR>

org.lwjgl.vulkan.VkDisplayPlaneProperties2KHR

All Implemented Interfaces:

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

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

Structure describing an available display plane.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR
• pNext must be NULL

See Also

VkDisplayPlanePropertiesKHR, GetPhysicalDeviceDisplayPlaneProperties2KHR

Layout

 struct VkDisplayPlaneProperties2KHR {
     VkStructureType sType();
     void * pNext();
     VkDisplayPlanePropertiesKHR displayPlaneProperties();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkDisplayPlaneProperties2KHR	calloc()	Returns a new VkDisplayPlaneProperties2KHR instance allocated with memCalloc.
static VkDisplayPlaneProperties2KHR.Buffer	calloc(int capacity)	Returns a new VkDisplayPlaneProperties2KHR.Buffer instance allocated with memCalloc.
static VkDisplayPlaneProperties2KHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayPlaneProperties2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayPlaneProperties2KHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayPlaneProperties2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayPlaneProperties2KHR	callocStack()	Deprecated.
static VkDisplayPlaneProperties2KHR.Buffer	callocStack(int capacity)	Deprecated.
static VkDisplayPlaneProperties2KHR.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayPlaneProperties2KHR	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayPlaneProperties2KHR	create()	Returns a new VkDisplayPlaneProperties2KHR instance allocated with BufferUtils.
static VkDisplayPlaneProperties2KHR.Buffer	create(int capacity)	Returns a new VkDisplayPlaneProperties2KHR.Buffer instance allocated with BufferUtils.
static VkDisplayPlaneProperties2KHR	create(long address)	Returns a new VkDisplayPlaneProperties2KHR instance for the specified memory address.
static VkDisplayPlaneProperties2KHR.Buffer	create(long address, int capacity)	Create a VkDisplayPlaneProperties2KHR.Buffer instance at the specified memory.
static @Nullable VkDisplayPlaneProperties2KHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDisplayPlaneProperties2KHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkDisplayPlanePropertiesKHR	displayPlaneProperties()	a VkDisplayPlanePropertiesKHR structure.
static VkDisplayPlaneProperties2KHR	malloc()	Returns a new VkDisplayPlaneProperties2KHR instance allocated with memAlloc.
static VkDisplayPlaneProperties2KHR.Buffer	malloc(int capacity)	Returns a new VkDisplayPlaneProperties2KHR.Buffer instance allocated with memAlloc.
static VkDisplayPlaneProperties2KHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayPlaneProperties2KHR.Buffer instance allocated on the specified MemoryStack.
static VkDisplayPlaneProperties2KHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayPlaneProperties2KHR instance allocated on the specified MemoryStack.
static VkDisplayPlaneProperties2KHR	mallocStack()	Deprecated.
static VkDisplayPlaneProperties2KHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkDisplayPlaneProperties2KHR.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayPlaneProperties2KHR	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayPlanePropertiesKHR	ndisplayPlaneProperties(long struct)	Unsafe version of displayPlaneProperties().
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
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.
VkDisplayPlaneProperties2KHR	pNext(long value)	Sets the specified value to the pNext() field.
VkDisplayPlaneProperties2KHR	set(int sType, long pNext)	Initializes this struct with the specified values.
VkDisplayPlaneProperties2KHR	set(VkDisplayPlaneProperties2KHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDisplayPlaneProperties2KHR	sType(int value)	Sets the specified value to the sType() field.
VkDisplayPlaneProperties2KHR	sType$Default()	Sets the STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR 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.

DISPLAYPLANEPROPERTIES

public static final int DISPLAYPLANEPROPERTIES

The struct member offsets.

Constructor Details

VkDisplayPlaneProperties2KHR

public VkDisplayPlaneProperties2KHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

displayPlaneProperties

public VkDisplayPlanePropertiesKHR displayPlaneProperties()

a VkDisplayPlanePropertiesKHR structure.

sType

public VkDisplayPlaneProperties2KHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDisplayPlaneProperties2KHR sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR value to the sType() field.

pNext

public VkDisplayPlaneProperties2KHR pNext(long value)

Sets the specified value to the pNext() field.

set

public VkDisplayPlaneProperties2KHR set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkDisplayPlaneProperties2KHR set(VkDisplayPlaneProperties2KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDisplayPlaneProperties2KHR malloc()

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

calloc

public static VkDisplayPlaneProperties2KHR calloc()

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

create

public static VkDisplayPlaneProperties2KHR create()

Returns a new VkDisplayPlaneProperties2KHR instance allocated with BufferUtils.

create

public static VkDisplayPlaneProperties2KHR create(long address)

Returns a new VkDisplayPlaneProperties2KHR instance for the specified memory address.

createSafe

public static @Nullable VkDisplayPlaneProperties2KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDisplayPlaneProperties2KHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDisplayPlaneProperties2KHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDisplayPlaneProperties2KHR.Buffer create(int capacity)

Returns a new VkDisplayPlaneProperties2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDisplayPlaneProperties2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDisplayPlaneProperties2KHR mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkDisplayPlaneProperties2KHR callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkDisplayPlaneProperties2KHR mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkDisplayPlaneProperties2KHR callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkDisplayPlaneProperties2KHR.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkDisplayPlaneProperties2KHR.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkDisplayPlaneProperties2KHR.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkDisplayPlaneProperties2KHR.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

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

Returns a new VkDisplayPlaneProperties2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndisplayPlaneProperties

public static VkDisplayPlanePropertiesKHR ndisplayPlaneProperties(long struct)

Unsafe version of displayPlaneProperties().

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.