Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDisplayPlaneInfo2KHR

extends Struct<VkDisplayPlaneInfo2KHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure defining the intended configuration of a display plane.
Description
Note

This parameter also implicitly specifies a display.

The members of VkDisplayPlaneInfo2KHR correspond to the arguments to GetDisplayPlaneCapabilitiesKHR, with sType and pNext added for extensibility.

Valid Usage (Implicit)
Host Synchronization
See Also

GetDisplayPlaneCapabilities2KHR

Layout


struct VkDisplayPlaneInfo2KHR {
    VkStructureType sType;
    void const * pNext;
    VkDisplayModeKHR mode;
    uint32_t planeIndex;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkDisplayPlaneInfo2KHR.Buffer

An array of VkDisplayPlaneInfo2KHR structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MODE

The struct member offsets.

public static final int
PLANEINDEX

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkDisplayPlaneInfo2KHR(long address, ByteBuffer container)

public
VkDisplayPlaneInfo2KHR(ByteBuffer container)

Creates a VkDisplayPlaneInfo2KHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkDisplayPlaneInfo2KHR
calloc()

Returns a new VkDisplayPlaneInfo2KHR instance allocated with memCalloc.

public static VkDisplayPlaneInfo2KHR.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkDisplayPlaneInfo2KHR.Buffer instance allocated with memCalloc.

public static VkDisplayPlaneInfo2KHR
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VkDisplayPlaneInfo2KHR.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkDisplayPlaneInfo2KHR
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayPlaneInfo2KHR
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayPlaneInfo2KHR.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayPlaneInfo2KHR.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkDisplayPlaneInfo2KHR
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkDisplayPlaneInfo2KHR
create()

Returns a new VkDisplayPlaneInfo2KHR instance allocated with BufferUtils.

public static VkDisplayPlaneInfo2KHR
create(long address)

Returns a new VkDisplayPlaneInfo2KHR instance for the specified memory address.

public static VkDisplayPlaneInfo2KHR.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkDisplayPlaneInfo2KHR.Buffer instance allocated with BufferUtils.

public static VkDisplayPlaneInfo2KHR.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkDisplayPlaneInfo2KHR.Buffer instance at the specified memory.

public static VkDisplayPlaneInfo2KHR
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkDisplayPlaneInfo2KHR.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkDisplayPlaneInfo2KHR
malloc()

Returns a new VkDisplayPlaneInfo2KHR instance allocated with memAlloc.

public static VkDisplayPlaneInfo2KHR.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkDisplayPlaneInfo2KHR.Buffer instance allocated with memAlloc.

public static VkDisplayPlaneInfo2KHR
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkDisplayPlaneInfo2KHR instance allocated on the specified MemoryStack.

public static VkDisplayPlaneInfo2KHR.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkDisplayPlaneInfo2KHR
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayPlaneInfo2KHR
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayPlaneInfo2KHR.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayPlaneInfo2KHR.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public long
mode()

the display mode the application intends to program when using the specified plane.

public VkDisplayPlaneInfo2KHR
mode(long value)

Sets the specified value to the mode field.

public static long
nmode(long struct)

Unsafe version of mode.

public static void
nmode(long struct, long value)

Unsafe version of mode.

public static int
nplaneIndex(long struct)

Unsafe version of planeIndex.

public static void
nplaneIndex(long struct, int value)

Unsafe version of planeIndex.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public int

Returns:

the value of the planeIndex field.
planeIndex()

public VkDisplayPlaneInfo2KHR
planeIndex(int value)

Sets the specified value to the planeIndex field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDisplayPlaneInfo2KHR
pNext(long value)

Sets the specified value to the pNext field.

public VkDisplayPlaneInfo2KHR
set(int sType, long pNext, long mode, int planeIndex)

Initializes this struct with the specified values.

public VkDisplayPlaneInfo2KHR

Returns:

this struct
set(VkDisplayPlaneInfo2KHR
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkDisplayPlaneInfo2KHR
sType(int value)

Sets the specified value to the sType field.

public VkDisplayPlaneInfo2KHR
sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

MODEback to summary
public static final int MODE

The struct member offsets.

PLANEINDEXback to summary
public static final int PLANEINDEX

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkDisplayPlaneInfo2KHRback to summary
protected VkDisplayPlaneInfo2KHR(long address, ByteBuffer container)
VkDisplayPlaneInfo2KHRback to summary
public VkDisplayPlaneInfo2KHR(ByteBuffer container)

Creates a VkDisplayPlaneInfo2KHR 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 Detail

callocback to summary
public static VkDisplayPlaneInfo2KHR calloc()

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

callocback to summary
public static VkDisplayPlaneInfo2KHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDisplayPlaneInfo2KHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkDisplayPlaneInfo2KHR.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkDisplayPlaneInfo2KHR callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDisplayPlaneInfo2KHR callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDisplayPlaneInfo2KHR.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDisplayPlaneInfo2KHR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkDisplayPlaneInfo2KHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkDisplayPlaneInfo2KHR create()

Returns a new VkDisplayPlaneInfo2KHR instance allocated with BufferUtils.

createback to summary
public static VkDisplayPlaneInfo2KHR create(long address)

Returns a new VkDisplayPlaneInfo2KHR instance for the specified memory address.

createback to summary
public static VkDisplayPlaneInfo2KHR.Buffer create(int capacity)

Returns a new VkDisplayPlaneInfo2KHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkDisplayPlaneInfo2KHR.Buffer create(long address, int capacity)

Create a VkDisplayPlaneInfo2KHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDisplayPlaneInfo2KHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkDisplayPlaneInfo2KHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkDisplayPlaneInfo2KHR malloc()

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

mallocback to summary
public static VkDisplayPlaneInfo2KHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDisplayPlaneInfo2KHR malloc(MemoryStack stack)

Returns a new VkDisplayPlaneInfo2KHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkDisplayPlaneInfo2KHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkDisplayPlaneInfo2KHR mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDisplayPlaneInfo2KHR mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDisplayPlaneInfo2KHR.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDisplayPlaneInfo2KHR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
modeback to summary
public long mode()

the display mode the application intends to program when using the specified plane.

Annotations
@NativeType:VkDisplayModeKHR
modeback to summary
public VkDisplayPlaneInfo2KHR mode(long value)

Sets the specified value to the mode field.

nmodeback to summary
public static long nmode(long struct)

Unsafe version of mode.

nmodeback to summary
public static void nmode(long struct, long value)

Unsafe version of mode.

nplaneIndexback to summary
public static int nplaneIndex(long struct)

Unsafe version of planeIndex.

nplaneIndexback to summary
public static void nplaneIndex(long struct, int value)

Unsafe version of planeIndex.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

planeIndexback to summary
public int planeIndex()
Returns:int

the value of the planeIndex field.

Annotations
@NativeType:uint32_t
planeIndexback to summary
public VkDisplayPlaneInfo2KHR planeIndex(int value)

Sets the specified value to the planeIndex field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkDisplayPlaneInfo2KHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkDisplayPlaneInfo2KHR set(int sType, long pNext, long mode, int planeIndex)

Initializes this struct with the specified values.

setback to summary
public VkDisplayPlaneInfo2KHR set(VkDisplayPlaneInfo2KHR src)

Copies the specified struct data to this struct.

Parameters
src:VkDisplayPlaneInfo2KHR

the source struct

Returns:VkDisplayPlaneInfo2KHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDisplayPlaneInfo2KHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkDisplayPlaneInfo2KHR sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDisplayPlaneInfo2KHR.Buffer

extends StructBuffer<VkDisplayPlaneInfo2KHR, VkDisplayPlaneInfo2KHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkDisplayPlaneInfo2KHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkDisplayPlaneInfo2KHR
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDisplayPlaneInfo2KHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkDisplayPlaneInfo2KHR
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public long

Returns:

the value of the VkDisplayPlaneInfo2KHR#mode field.
mode()

public VkDisplayPlaneInfo2KHR.Buffer
mode(long value)

Sets the specified value to the VkDisplayPlaneInfo2KHR#mode field.

public int

Returns:

the value of the planeIndex field.
planeIndex()

public VkDisplayPlaneInfo2KHR.Buffer
planeIndex(int value)

Sets the specified value to the planeIndex field.

public long

Returns:

the value of the VkDisplayPlaneInfo2KHR#pNext field.
pNext()

public VkDisplayPlaneInfo2KHR.Buffer
pNext(long value)

Sets the specified value to the VkDisplayPlaneInfo2KHR#pNext field.

protected VkDisplayPlaneInfo2KHR.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkDisplayPlaneInfo2KHR#sType field.
sType()

public VkDisplayPlaneInfo2KHR.Buffer
sType(int value)

Sets the specified value to the VkDisplayPlaneInfo2KHR#sType field.

public VkDisplayPlaneInfo2KHR.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR value to the VkDisplayPlaneInfo2KHR#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDisplayPlaneInfo2KHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDisplayPlaneInfo2KHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkDisplayPlaneInfo2KHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkDisplayPlaneInfo2KHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
modeback to summary
public long mode()
Returns:long

the value of the VkDisplayPlaneInfo2KHR#mode field.

Annotations
@NativeType:VkDisplayModeKHR
modeback to summary
public VkDisplayPlaneInfo2KHR.Buffer mode(long value)

Sets the specified value to the VkDisplayPlaneInfo2KHR#mode field.

planeIndexback to summary
public int planeIndex()
Returns:int

the value of the planeIndex field.

Annotations
@NativeType:uint32_t
planeIndexback to summary
public VkDisplayPlaneInfo2KHR.Buffer planeIndex(int value)

Sets the specified value to the planeIndex field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkDisplayPlaneInfo2KHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkDisplayPlaneInfo2KHR.Buffer pNext(long value)

Sets the specified value to the VkDisplayPlaneInfo2KHR#pNext field.

selfback to summary
protected VkDisplayPlaneInfo2KHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkDisplayPlaneInfo2KHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDisplayPlaneInfo2KHR.Buffer sType(int value)

Sets the specified value to the VkDisplayPlaneInfo2KHR#sType field.

sType$Defaultback to summary
public VkDisplayPlaneInfo2KHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR value to the VkDisplayPlaneInfo2KHR#sType field.