Modifier and Type	Class and Description
public static class	VkDisplayPlanePropertiesKHR.Buffer An array of `VkDisplayPlanePropertiesKHR` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	CURRENTDISPLAY The struct member offsets.
public static final int	CURRENTSTACKINDEX The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Access	Constructor and Description
protected	VkDisplayPlanePropertiesKHR(long address, ByteBuffer container)
public	VkDisplayPlanePropertiesKHR(ByteBuffer container) Creates a `VkDisplayPlanePropertiesKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkDisplayPlanePropertiesKHR	calloc() Returns a new `VkDisplayPlanePropertiesKHR` instance allocated with `memCalloc`.
public static VkDisplayPlanePropertiesKHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated with `memCalloc`.
public static VkDisplayPlanePropertiesKHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDisplayPlanePropertiesKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkDisplayPlanePropertiesKHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkDisplayPlanePropertiesKHR	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkDisplayPlanePropertiesKHR	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkDisplayPlanePropertiesKHR.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkDisplayPlanePropertiesKHR.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkDisplayPlanePropertiesKHR	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 VkDisplayPlanePropertiesKHR	create() Returns a new `VkDisplayPlanePropertiesKHR` instance allocated with `BufferUtils`.
public static VkDisplayPlanePropertiesKHR	create(long address) Returns a new `VkDisplayPlanePropertiesKHR` instance for the specified memory address.
public static VkDisplayPlanePropertiesKHR.Buffer	create(int the buffer capacity capacity) Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated with `BufferUtils`.
public static VkDisplayPlanePropertiesKHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkDisplayPlanePropertiesKHR.Buffer` instance at the specified memory.
public static VkDisplayPlanePropertiesKHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkDisplayPlanePropertiesKHR.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	currentDisplay() the handle of the display the plane is currently associated with.
public int	currentStackIndex() the current z-order of the plane.
public static VkDisplayPlanePropertiesKHR	malloc() Returns a new `VkDisplayPlanePropertiesKHR` instance allocated with `memAlloc`.
public static VkDisplayPlanePropertiesKHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated with `memAlloc`.
public static VkDisplayPlanePropertiesKHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDisplayPlanePropertiesKHR` instance allocated on the specified `MemoryStack`.
public static VkDisplayPlanePropertiesKHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated on the specified `MemoryStack`.
public static VkDisplayPlanePropertiesKHR	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkDisplayPlanePropertiesKHR	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkDisplayPlanePropertiesKHR.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkDisplayPlanePropertiesKHR.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static long	ncurrentDisplay(long struct) Unsafe version of `currentDisplay`.
public static int	ncurrentStackIndex(long struct) Unsafe version of `currentStackIndex`.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

CURRENTDISPLAY	back to summary
public static final int CURRENTDISPLAY The struct member offsets.

CURRENTSTACKINDEX	back to summary
public static final int CURRENTSTACKINDEX The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

VkDisplayPlanePropertiesKHR	back to summary
protected VkDisplayPlanePropertiesKHR(long address, ByteBuffer container)

VkDisplayPlanePropertiesKHR back to summary

VkDisplayPlanePropertiesKHR	back to summary
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.

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 Detail

calloc	back to summary
public static VkDisplayPlanePropertiesKHR calloc() Returns a new `VkDisplayPlanePropertiesKHR` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkDisplayPlanePropertiesKHR.Buffer calloc(int capacity) Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkDisplayPlanePropertiesKHR.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkDisplayPlanePropertiesKHR calloc(MemoryStack stack) Returns a new `VkDisplayPlanePropertiesKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkDisplayPlanePropertiesKHR calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkDisplayPlanePropertiesKHR.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkDisplayPlanePropertiesKHR.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

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

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

callocStack back to summary

callocStack	back to summary
public static VkDisplayPlanePropertiesKHR callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDisplayPlanePropertiesKHR callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkDisplayPlanePropertiesKHR callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDisplayPlanePropertiesKHR callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkDisplayPlanePropertiesKHR.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDisplayPlanePropertiesKHR.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkDisplayPlanePropertiesKHR.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDisplayPlanePropertiesKHR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkDisplayPlanePropertiesKHR 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

protected VkDisplayPlanePropertiesKHR 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

create	back to summary
public static VkDisplayPlanePropertiesKHR create() Returns a new `VkDisplayPlanePropertiesKHR` instance allocated with `BufferUtils`.

create	back to summary
public static VkDisplayPlanePropertiesKHR create(long address) Returns a new `VkDisplayPlanePropertiesKHR` instance for the specified memory address.

create back to summary

create	back to summary
public static VkDisplayPlanePropertiesKHR.Buffer create(int capacity) Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkDisplayPlanePropertiesKHR.Buffer create(int capacity)

Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkDisplayPlanePropertiesKHR.Buffer create(long address, int capacity) Create a `VkDisplayPlanePropertiesKHR.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkDisplayPlanePropertiesKHR.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkDisplayPlanePropertiesKHR createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkDisplayPlanePropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkDisplayPlanePropertiesKHR.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

currentDisplay back to summary

currentDisplay	back to summary
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`. Annotations @NativeType:VkDisplayKHR

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.

Annotations

@NativeType:VkDisplayKHR

currentStackIndex back to summary

currentStackIndex	back to summary
public int currentStackIndex() the current z-order of the plane. This will be between 0 and the value returned by `vkGetPhysicalDeviceDisplayPlanePropertiesKHR` in `pPropertyCount`. Annotations @NativeType:uint32_t

public int currentStackIndex()

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

Annotations

@NativeType:uint32_t

malloc	back to summary
public static VkDisplayPlanePropertiesKHR malloc() Returns a new `VkDisplayPlanePropertiesKHR` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkDisplayPlanePropertiesKHR.Buffer malloc(int capacity) Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkDisplayPlanePropertiesKHR.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkDisplayPlanePropertiesKHR malloc(MemoryStack stack) Returns a new `VkDisplayPlanePropertiesKHR` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkDisplayPlanePropertiesKHR malloc(MemoryStack stack)

Returns a new VkDisplayPlanePropertiesKHR instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkDisplayPlanePropertiesKHR.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static VkDisplayPlanePropertiesKHR mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDisplayPlanePropertiesKHR mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkDisplayPlanePropertiesKHR mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDisplayPlanePropertiesKHR mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkDisplayPlanePropertiesKHR.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDisplayPlanePropertiesKHR.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkDisplayPlanePropertiesKHR.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDisplayPlanePropertiesKHR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

ncurrentDisplay	back to summary
public static long ncurrentDisplay(long struct) Unsafe version of `currentDisplay`.

ncurrentStackIndex	back to summary
public static int ncurrentStackIndex(long struct) Unsafe version of `currentStackIndex`.

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

org.lwjgl.vulkan back to summary

public Class VkDisplayPlanePropertiesKHR.Buffer

Class Inheritance

extends StructBuffer<VkDisplayPlanePropertiesKHR, VkDisplayPlanePropertiesKHR.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkDisplayPlanePropertiesKHR.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkDisplayPlanePropertiesKHR structs.

Field Summary

Modifier and Type	Field and Description
private static final VkDisplayPlanePropertiesKHR	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkDisplayPlanePropertiesKHR.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 Type	Method and Description
public long	Returns: the value of the `VkDisplayPlanePropertiesKHR#currentDisplay` field. currentDisplay()
public int	Returns: the value of the `VkDisplayPlanePropertiesKHR#currentStackIndex` field. currentStackIndex()
protected VkDisplayPlanePropertiesKHR	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VkDisplayPlanePropertiesKHR.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkDisplayPlanePropertiesKHR ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkDisplayPlanePropertiesKHR.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 `VkDisplayPlanePropertiesKHR#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkDisplayPlanePropertiesKHR.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 VkDisplayPlanePropertiesKHR#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

currentDisplay	back to summary
public long currentDisplay() Returns:long the value of the `VkDisplayPlanePropertiesKHR#currentDisplay` field. Annotations @NativeType:VkDisplayKHR

currentStackIndex	back to summary
public int currentStackIndex() Returns:int the value of the `VkDisplayPlanePropertiesKHR#currentStackIndex` field. Annotations @NativeType:uint32_t

getElementFactory	back to summary
protected VkDisplayPlanePropertiesKHR getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected VkDisplayPlanePropertiesKHR getElementFactory()

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

Annotations