Package org.lwjgl.vulkan

Class VkDisplayPlanePropertiesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDisplayPlanePropertiesKHR>

org.lwjgl.vulkan.VkDisplayPlanePropertiesKHR

All Implemented Interfaces:

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

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

Structure describing display plane properties.

See Also

VkDisplayPlaneProperties2KHR, GetPhysicalDeviceDisplayPlanePropertiesKHR

Layout

 struct VkDisplayPlanePropertiesKHR {
     VkDisplayKHR currentDisplay();
     uint32_t currentStackIndex();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDisplayPlanePropertiesKHR.Buffer	An array of VkDisplayPlanePropertiesKHR 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	CURRENTDISPLAY	The struct member offsets.
static final int	CURRENTSTACKINDEX	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkDisplayPlanePropertiesKHR(ByteBuffer container)	Creates a VkDisplayPlanePropertiesKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDisplayPlanePropertiesKHR	calloc()	Returns a new VkDisplayPlanePropertiesKHR instance allocated with memCalloc.
static VkDisplayPlanePropertiesKHR.Buffer	calloc(int capacity)	Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated with memCalloc.
static VkDisplayPlanePropertiesKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayPlanePropertiesKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayPlanePropertiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayPlanePropertiesKHR	callocStack()	Deprecated.
static VkDisplayPlanePropertiesKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkDisplayPlanePropertiesKHR.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayPlanePropertiesKHR	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayPlanePropertiesKHR	create()	Returns a new VkDisplayPlanePropertiesKHR instance allocated with BufferUtils.
static VkDisplayPlanePropertiesKHR.Buffer	create(int capacity)	Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated with BufferUtils.
static VkDisplayPlanePropertiesKHR	create(long address)	Returns a new VkDisplayPlanePropertiesKHR instance for the specified memory address.
static VkDisplayPlanePropertiesKHR.Buffer	create(long address, int capacity)	Create a VkDisplayPlanePropertiesKHR.Buffer instance at the specified memory.
static @Nullable VkDisplayPlanePropertiesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDisplayPlanePropertiesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	currentDisplay()	the handle of the display the plane is currently associated with.
int	currentStackIndex()	the current z-order of the plane.
static VkDisplayPlanePropertiesKHR	malloc()	Returns a new VkDisplayPlanePropertiesKHR instance allocated with memAlloc.
static VkDisplayPlanePropertiesKHR.Buffer	malloc(int capacity)	Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated with memAlloc.
static VkDisplayPlanePropertiesKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated on the specified MemoryStack.
static VkDisplayPlanePropertiesKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayPlanePropertiesKHR instance allocated on the specified MemoryStack.
static VkDisplayPlanePropertiesKHR	mallocStack()	Deprecated.
static VkDisplayPlanePropertiesKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkDisplayPlanePropertiesKHR.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayPlanePropertiesKHR	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	ncurrentDisplay(long struct)	Unsafe version of currentDisplay().
static int	ncurrentStackIndex(long struct)	Unsafe version of currentStackIndex().
int	sizeof()

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.

CURRENTDISPLAY

public static final int CURRENTDISPLAY

The struct member offsets.

CURRENTSTACKINDEX

public static final int CURRENTSTACKINDEX

The struct member offsets.

Constructor Details

VkDisplayPlanePropertiesKHR

public VkDisplayPlanePropertiesKHR(ByteBuffer container)

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

currentDisplay

public long currentDisplay()

the handle of the display the plane is currently associated with. If the plane is not currently attached to any displays, this will be NULL_HANDLE.

currentStackIndex

public int currentStackIndex()

the current z-order of the plane. This will be between 0 and the value returned by vkGetPhysicalDeviceDisplayPlanePropertiesKHR in pPropertyCount.

malloc

public static VkDisplayPlanePropertiesKHR malloc()

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

calloc

public static VkDisplayPlanePropertiesKHR calloc()

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

create

public static VkDisplayPlanePropertiesKHR create()

Returns a new VkDisplayPlanePropertiesKHR instance allocated with BufferUtils.

create

public static VkDisplayPlanePropertiesKHR create(long address)

Returns a new VkDisplayPlanePropertiesKHR instance for the specified memory address.

createSafe

public static @Nullable VkDisplayPlanePropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDisplayPlanePropertiesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDisplayPlanePropertiesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDisplayPlanePropertiesKHR.Buffer create(int capacity)

Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDisplayPlanePropertiesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDisplayPlanePropertiesKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayPlanePropertiesKHR callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Returns a new VkDisplayPlanePropertiesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkDisplayPlanePropertiesKHR.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

ncurrentDisplay

public static long ncurrentDisplay(long struct)

Unsafe version of currentDisplay().

ncurrentStackIndex

public static int ncurrentStackIndex(long struct)

Unsafe version of currentStackIndex().