Package org.lwjgl.vulkan
Class VkDisplayPlaneInfo2KHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkDisplayPlaneInfo2KHR>
org.lwjgl.vulkan.VkDisplayPlaneInfo2KHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkDisplayPlaneInfo2KHR
extends org.lwjgl.system.Struct<VkDisplayPlaneInfo2KHR>
implements org.lwjgl.system.NativeResource
Structure defining the intended configuration of a display plane.
Description
Note
This parameter also implicitly specifies a display.
planeIndexis the plane which the application intends to use with the display.
The members of VkDisplayPlaneInfo2KHR correspond to the arguments to GetDisplayPlaneCapabilitiesKHR, with sType and pNext added for extensibility.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHRpNextmust beNULLmodemust be a validVkDisplayModeKHRhandle
Host Synchronization
- Host access to
modemust be externally synchronized
See Also
GetDisplayPlaneCapabilities2KHR
Layout
struct VkDisplayPlaneInfo2KHR {
VkStructureType sType();
void const * pNext();
VkDisplayModeKHR mode();
uint32_t planeIndex;
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkDisplayPlaneInfo2KHR(ByteBuffer container) Creates aVkDisplayPlaneInfo2KHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkDisplayPlaneInfo2KHRcalloc()Returns a newVkDisplayPlaneInfo2KHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkDisplayPlaneInfo2KHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayPlaneInfo2KHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDisplayPlaneInfo2KHRcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayPlaneInfo2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDisplayPlaneInfo2KHRDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkDisplayPlaneInfo2KHRcallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkDisplayPlaneInfo2KHRcreate()Returns a newVkDisplayPlaneInfo2KHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkDisplayPlaneInfo2KHR.Bufferinstance allocated withBufferUtils.static VkDisplayPlaneInfo2KHRcreate(long address) Returns a newVkDisplayPlaneInfo2KHRinstance for the specified memory address.create(long address, int capacity) Create aVkDisplayPlaneInfo2KHR.Bufferinstance at the specified memory.static @Nullable VkDisplayPlaneInfo2KHRcreateSafe(long address) static @Nullable VkDisplayPlaneInfo2KHR.BuffercreateSafe(long address, int capacity) static VkDisplayPlaneInfo2KHRmalloc()Returns a newVkDisplayPlaneInfo2KHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkDisplayPlaneInfo2KHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayPlaneInfo2KHR.Bufferinstance allocated on the specifiedMemoryStack.static VkDisplayPlaneInfo2KHRmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayPlaneInfo2KHRinstance allocated on the specifiedMemoryStack.static VkDisplayPlaneInfo2KHRDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkDisplayPlaneInfo2KHRmallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.longmode()the display mode the application intends to program when using the specified plane.mode(long value) Sets the specified value to themode()field.static longnmode(long struct) Unsafe version ofmode().static voidnmode(long struct, long value) Unsafe version ofmode.static intnplaneIndex(long struct) Unsafe version ofplaneIndex().static voidnplaneIndex(long struct, int value) Unsafe version ofplaneIndex.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.intplaneIndex(int value) Sets the specified value to theplaneIndexfield.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, long mode, int planeIndex) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHRvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
MODE
public static final int MODEThe struct member offsets. -
PLANEINDEX
public static final int PLANEINDEXThe struct member offsets.
-
-
Constructor Details
-
VkDisplayPlaneInfo2KHR
Creates aVkDisplayPlaneInfo2KHRinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkDisplayPlaneInfo2KHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
mode
public long mode()the display mode the application intends to program when using the specified plane. -
planeIndex
public int planeIndex()- Returns:
- the value of the
planeIndexfield.
-
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
mode
Sets the specified value to themode()field. -
planeIndex
Sets the specified value to theplaneIndexfield. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkDisplayPlaneInfo2KHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkDisplayPlaneInfo2KHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkDisplayPlaneInfo2KHRinstance allocated withBufferUtils. -
create
Returns a newVkDisplayPlaneInfo2KHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkDisplayPlaneInfo2KHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkDisplayPlaneInfo2KHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkDisplayPlaneInfo2KHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkDisplayPlaneInfo2KHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkDisplayPlaneInfo2KHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkDisplayPlaneInfo2KHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkDisplayPlaneInfo2KHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkDisplayPlaneInfo2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkDisplayPlaneInfo2KHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayPlaneInfo2KHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkDisplayPlaneInfo2KHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayPlaneInfo2KHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nmode
public static long nmode(long struct) Unsafe version ofmode(). -
nplaneIndex
public static int nplaneIndex(long struct) Unsafe version ofplaneIndex(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nmode
public static void nmode(long struct, long value) Unsafe version ofmode. -
nplaneIndex
public static void nplaneIndex(long struct, int value) Unsafe version ofplaneIndex.
-