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

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

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

Method Summary

Modifier and Type	Method and Description
public static VkSurfaceFormatKHR	calloc() Returns a new `VkSurfaceFormatKHR` instance allocated with `memCalloc`.
public static VkSurfaceFormatKHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated with `memCalloc`.
public static VkSurfaceFormatKHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSurfaceFormatKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSurfaceFormatKHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSurfaceFormatKHR	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSurfaceFormatKHR	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSurfaceFormatKHR.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSurfaceFormatKHR.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public int	colorSpace() a presentation `VkColorSpaceKHR` that is compatible with the surface.
protected VkSurfaceFormatKHR	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 VkSurfaceFormatKHR	create() Returns a new `VkSurfaceFormatKHR` instance allocated with `BufferUtils`.
public static VkSurfaceFormatKHR	create(long address) Returns a new `VkSurfaceFormatKHR` instance for the specified memory address.
public static VkSurfaceFormatKHR.Buffer	create(int the buffer capacity capacity) Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated with `BufferUtils`.
public static VkSurfaceFormatKHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkSurfaceFormatKHR.Buffer` instance at the specified memory.
public static VkSurfaceFormatKHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSurfaceFormatKHR.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	format() a `VkFormat` that is compatible with the specified surface.
public static VkSurfaceFormatKHR	malloc() Returns a new `VkSurfaceFormatKHR` instance allocated with `memAlloc`.
public static VkSurfaceFormatKHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated with `memAlloc`.
public static VkSurfaceFormatKHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSurfaceFormatKHR` instance allocated on the specified `MemoryStack`.
public static VkSurfaceFormatKHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated on the specified `MemoryStack`.
public static VkSurfaceFormatKHR	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSurfaceFormatKHR	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSurfaceFormatKHR.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSurfaceFormatKHR.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	ncolorSpace(long struct) Unsafe version of `colorSpace`.
public static int	nformat(long struct) Unsafe version of `format`.
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.

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

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

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

Constructor Detail

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

VkSurfaceFormatKHR back to summary

VkSurfaceFormatKHR	back to summary
public VkSurfaceFormatKHR(ByteBuffer container) Creates a `VkSurfaceFormatKHR` 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 VkSurfaceFormatKHR(ByteBuffer container)

Creates a VkSurfaceFormatKHR 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 VkSurfaceFormatKHR calloc() Returns a new `VkSurfaceFormatKHR` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

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

public static VkSurfaceFormatKHR.Buffer calloc(int capacity)

Returns a new VkSurfaceFormatKHR.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 VkSurfaceFormatKHR calloc(MemoryStack stack) Returns a new `VkSurfaceFormatKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkSurfaceFormatKHR calloc(MemoryStack stack)

Returns a new VkSurfaceFormatKHR 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 VkSurfaceFormatKHR.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkSurfaceFormatKHR.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 VkSurfaceFormatKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkSurfaceFormatKHR.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 VkSurfaceFormatKHR callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSurfaceFormatKHR 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 VkSurfaceFormatKHR callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSurfaceFormatKHR 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 VkSurfaceFormatKHR.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSurfaceFormatKHR.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 VkSurfaceFormatKHR.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

colorSpace back to summary

colorSpace	back to summary
public int colorSpace() a presentation `VkColorSpaceKHR` that is compatible with the surface. Annotations @NativeType:VkColorSpaceKHR

public int colorSpace()

a presentation VkColorSpaceKHR that is compatible with the surface.

Annotations

@NativeType:VkColorSpaceKHR

create back to summary

create	back to summary
protected VkSurfaceFormatKHR 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 VkSurfaceFormatKHR 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 VkSurfaceFormatKHR create() Returns a new `VkSurfaceFormatKHR` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkSurfaceFormatKHR.Buffer create(int capacity)

Returns a new VkSurfaceFormatKHR.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkSurfaceFormatKHR.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 VkSurfaceFormatKHR createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkSurfaceFormatKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

format back to summary

format	back to summary
public int format() a `VkFormat` that is compatible with the specified surface. Annotations @NativeType:VkFormat

public int format()

a VkFormat that is compatible with the specified surface.

Annotations

@NativeType:VkFormat

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

malloc back to summary

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

public static VkSurfaceFormatKHR.Buffer malloc(int capacity)

Returns a new VkSurfaceFormatKHR.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 VkSurfaceFormatKHR malloc(MemoryStack stack) Returns a new `VkSurfaceFormatKHR` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkSurfaceFormatKHR malloc(MemoryStack stack)

Returns a new VkSurfaceFormatKHR 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 VkSurfaceFormatKHR.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

Returns a new VkSurfaceFormatKHR.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 VkSurfaceFormatKHR mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSurfaceFormatKHR 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 VkSurfaceFormatKHR mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSurfaceFormatKHR 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 VkSurfaceFormatKHR.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSurfaceFormatKHR.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 VkSurfaceFormatKHR.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

ncolorSpace	back to summary
public static int ncolorSpace(long struct) Unsafe version of `colorSpace`.

nformat	back to summary
public static int nformat(long struct) Unsafe version of `format`.

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 VkSurfaceFormatKHR.Buffer

Class Inheritance

extends StructBuffer<VkSurfaceFormatKHR, VkSurfaceFormatKHR.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of VkSurfaceFormatKHR structs.

Field Summary

Modifier and Type	Field and Description
private static final VkSurfaceFormatKHR	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkSurfaceFormatKHR.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 int	Returns: the value of the `VkSurfaceFormatKHR#colorSpace` field. colorSpace()
public int	Returns: the value of the `VkSurfaceFormatKHR#format` field. format()
protected VkSurfaceFormatKHR	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VkSurfaceFormatKHR.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 VkSurfaceFormatKHR ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkSurfaceFormatKHR.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 `VkSurfaceFormatKHR#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 VkSurfaceFormatKHR.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 VkSurfaceFormatKHR#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

colorSpace	back to summary
public int colorSpace() Returns:int the value of the `VkSurfaceFormatKHR#colorSpace` field. Annotations @NativeType:VkColorSpaceKHR

format	back to summary
public int format() Returns:int the value of the `VkSurfaceFormatKHR#format` field. Annotations @NativeType:VkFormat

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

getElementFactory

back to summary

protected VkSurfaceFormatKHR getElementFactory()

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

Annotations

@Override

self	back to summary
protected VkSurfaceFormatKHR.Buffer self() Implements abstract org.lwjgl.system.CustomBuffer.self. Annotations @Override

self

back to summary

protected VkSurfaceFormatKHR.Buffer self()

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

Annotations

@Override

public Class VkSurfaceFormatKHR

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkSurfaceFormatKHR.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail