Package org.lwjgl.vulkan
Class VkDisplayPlaneInfo2KHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDisplayPlaneInfo2KHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkDisplayPlaneInfo2KHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure defining the intended configuration of a display plane.Description
Note
This parameter also implicitly specifies a display.
planeIndex
is the plane which the application intends to use with the display.
The members of
VkDisplayPlaneInfo2KHR
correspond to the arguments toGetDisplayPlaneCapabilitiesKHR
, withsType
andpNext
added for extensibility.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR
pNext
must beNULL
mode
must be a validVkDisplayModeKHR
handle
Host Synchronization
- Host access to
mode
must be externally synchronized
See Also
GetDisplayPlaneCapabilities2KHR
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.mode
– the display mode the application intends to program when using the specified plane.
Layout
struct VkDisplayPlaneInfo2KHR { VkStructureType sType; void const * pNext; VkDisplayModeKHR mode; uint32_t planeIndex; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkDisplayPlaneInfo2KHR.Buffer
An array ofVkDisplayPlaneInfo2KHR
structs.
-
Constructor Summary
Constructors Constructor Description VkDisplayPlaneInfo2KHR(java.nio.ByteBuffer container)
Creates aVkDisplayPlaneInfo2KHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkDisplayPlaneInfo2KHR
calloc()
Returns a newVkDisplayPlaneInfo2KHR
instance allocated withmemCalloc
.static VkDisplayPlaneInfo2KHR.Buffer
calloc(int capacity)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated withmemCalloc
.static VkDisplayPlaneInfo2KHR
callocStack()
Returns a newVkDisplayPlaneInfo2KHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayPlaneInfo2KHR.Buffer
callocStack(int capacity)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayPlaneInfo2KHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPlaneInfo2KHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneInfo2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPlaneInfo2KHR
create()
Returns a newVkDisplayPlaneInfo2KHR
instance allocated withBufferUtils
.static VkDisplayPlaneInfo2KHR.Buffer
create(int capacity)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated withBufferUtils
.static VkDisplayPlaneInfo2KHR
create(long address)
Returns a newVkDisplayPlaneInfo2KHR
instance for the specified memory address.static VkDisplayPlaneInfo2KHR.Buffer
create(long address, int capacity)
Create aVkDisplayPlaneInfo2KHR.Buffer
instance at the specified memory.static VkDisplayPlaneInfo2KHR
createSafe(long address)
static VkDisplayPlaneInfo2KHR.Buffer
createSafe(long address, int capacity)
static VkDisplayPlaneInfo2KHR
malloc()
Returns a newVkDisplayPlaneInfo2KHR
instance allocated withmemAlloc
.static VkDisplayPlaneInfo2KHR.Buffer
malloc(int capacity)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated withmemAlloc
.static VkDisplayPlaneInfo2KHR
mallocStack()
Returns a newVkDisplayPlaneInfo2KHR
instance allocated on the thread-localMemoryStack
.static VkDisplayPlaneInfo2KHR.Buffer
mallocStack(int capacity)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkDisplayPlaneInfo2KHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkDisplayPlaneInfo2KHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneInfo2KHR
instance allocated on the specifiedMemoryStack
.long
mode()
Returns the value of themode
field.VkDisplayPlaneInfo2KHR
mode(long value)
Sets the specified value to themode
field.static long
nmode(long struct)
Unsafe version ofmode()
.static void
nmode(long struct, long value)
Unsafe version ofmode
.static int
nplaneIndex(long struct)
Unsafe version ofplaneIndex()
.static void
nplaneIndex(long struct, int value)
Unsafe version ofplaneIndex
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.int
planeIndex()
Returns the value of theplaneIndex
field.VkDisplayPlaneInfo2KHR
planeIndex(int value)
Sets the specified value to theplaneIndex
field.long
pNext()
Returns the value of thepNext
field.VkDisplayPlaneInfo2KHR
pNext(long value)
Sets the specified value to thepNext
field.VkDisplayPlaneInfo2KHR
set(int sType, long pNext, long mode, int planeIndex)
Initializes this struct with the specified values.VkDisplayPlaneInfo2KHR
set(VkDisplayPlaneInfo2KHR src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkDisplayPlaneInfo2KHR
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkDisplayPlaneInfo2KHR
public VkDisplayPlaneInfo2KHR(java.nio.ByteBuffer container)
Creates aVkDisplayPlaneInfo2KHR
instance at the current position of the specifiedByteBuffer
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
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
mode
public long mode()
Returns the value of themode
field.
-
planeIndex
public int planeIndex()
Returns the value of theplaneIndex
field.
-
sType
public VkDisplayPlaneInfo2KHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDisplayPlaneInfo2KHR pNext(long value)
Sets the specified value to thepNext
field.
-
mode
public VkDisplayPlaneInfo2KHR mode(long value)
Sets the specified value to themode
field.
-
planeIndex
public VkDisplayPlaneInfo2KHR planeIndex(int value)
Sets the specified value to theplaneIndex
field.
-
set
public VkDisplayPlaneInfo2KHR set(int sType, long pNext, long mode, int planeIndex)
Initializes this struct with the specified values.
-
set
public VkDisplayPlaneInfo2KHR set(VkDisplayPlaneInfo2KHR src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkDisplayPlaneInfo2KHR malloc()
Returns a newVkDisplayPlaneInfo2KHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDisplayPlaneInfo2KHR calloc()
Returns a newVkDisplayPlaneInfo2KHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDisplayPlaneInfo2KHR create()
Returns a newVkDisplayPlaneInfo2KHR
instance allocated withBufferUtils
.
-
create
public static VkDisplayPlaneInfo2KHR create(long address)
Returns a newVkDisplayPlaneInfo2KHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkDisplayPlaneInfo2KHR createSafe(long address)
-
malloc
public static VkDisplayPlaneInfo2KHR.Buffer malloc(int capacity)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDisplayPlaneInfo2KHR.Buffer calloc(int capacity)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayPlaneInfo2KHR.Buffer create(int capacity)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayPlaneInfo2KHR.Buffer create(long address, int capacity)
Create aVkDisplayPlaneInfo2KHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDisplayPlaneInfo2KHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDisplayPlaneInfo2KHR mallocStack()
Returns a newVkDisplayPlaneInfo2KHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDisplayPlaneInfo2KHR callocStack()
Returns a newVkDisplayPlaneInfo2KHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDisplayPlaneInfo2KHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneInfo2KHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDisplayPlaneInfo2KHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneInfo2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDisplayPlaneInfo2KHR.Buffer mallocStack(int capacity)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDisplayPlaneInfo2KHR.Buffer callocStack(int capacity)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDisplayPlaneInfo2KHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDisplayPlaneInfo2KHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneInfo2KHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
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
.
-
-