Package org.lwjgl.vulkan

Class VkDisplayPlaneCapabilities2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDisplayPlaneCapabilities2KHR>

org.lwjgl.vulkan.VkDisplayPlaneCapabilities2KHR

All Implemented Interfaces:

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

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

Structure describing the capabilities of a mode and plane combination.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR
• pNext must be NULL

See Also

VkDisplayPlaneCapabilitiesKHR, GetDisplayPlaneCapabilities2KHR

Layout

 struct VkDisplayPlaneCapabilities2KHR {
     VkStructureType sType();
     void * pNext();
     VkDisplayPlaneCapabilitiesKHR capabilities();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDisplayPlaneCapabilities2KHR.Buffer	An array of VkDisplayPlaneCapabilities2KHR 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	CAPABILITIES	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
VkDisplayPlaneCapabilities2KHR(ByteBuffer container)	Creates a VkDisplayPlaneCapabilities2KHR instance at the current position of the specified ByteBuffer container.

Method Summary

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

CAPABILITIES

public static final int CAPABILITIES

The struct member offsets.

Constructor Details

VkDisplayPlaneCapabilities2KHR

public VkDisplayPlaneCapabilities2KHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

capabilities

public VkDisplayPlaneCapabilitiesKHR capabilities()

a VkDisplayPlaneCapabilitiesKHR structure.

sType

public VkDisplayPlaneCapabilities2KHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDisplayPlaneCapabilities2KHR sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR value to the sType() field.

pNext

public VkDisplayPlaneCapabilities2KHR pNext(long value)

Sets the specified value to the pNext() field.

set

public VkDisplayPlaneCapabilities2KHR set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkDisplayPlaneCapabilities2KHR set(VkDisplayPlaneCapabilities2KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDisplayPlaneCapabilities2KHR malloc()

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

calloc

public static VkDisplayPlaneCapabilities2KHR calloc()

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

create

public static VkDisplayPlaneCapabilities2KHR create()

Returns a new VkDisplayPlaneCapabilities2KHR instance allocated with BufferUtils.

create

public static VkDisplayPlaneCapabilities2KHR create(long address)

Returns a new VkDisplayPlaneCapabilities2KHR instance for the specified memory address.

createSafe

public static @Nullable VkDisplayPlaneCapabilities2KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDisplayPlaneCapabilities2KHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDisplayPlaneCapabilities2KHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDisplayPlaneCapabilities2KHR.Buffer create(int capacity)

Returns a new VkDisplayPlaneCapabilities2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDisplayPlaneCapabilities2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDisplayPlaneCapabilities2KHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayPlaneCapabilities2KHR callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayPlaneCapabilities2KHR.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 VkDisplayPlaneCapabilities2KHR.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 VkDisplayPlaneCapabilities2KHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDisplayPlaneCapabilities2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncapabilities

public static VkDisplayPlaneCapabilitiesKHR ncapabilities(long struct)

Unsafe version of capabilities().

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.