Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBufferUsageFlags2CreateInfoKHR

extends Struct<VkBufferUsageFlags2CreateInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Extended buffer usage flags.
Description

If this structure is included in the pNext chain of a buffer creation structure, usage is used instead of the corresponding usage value passed in that creation structure, allowing additional usage flags to be specified. If this structure is included in the pNext chain of a buffer query structure, the usage flags of the buffer are returned in usage of this structure, and the usage flags representable in usage of the buffer query structure are also returned in that field.

Valid Usage (Implicit)

Layout


struct VkBufferUsageFlags2CreateInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkBufferUsageFlags2KHR usage;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkBufferUsageFlags2CreateInfoKHR.Buffer

An array of VkBufferUsageFlags2CreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
USAGE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkBufferUsageFlags2CreateInfoKHR(long address, ByteBuffer container)

public
VkBufferUsageFlags2CreateInfoKHR(ByteBuffer container)

Creates a VkBufferUsageFlags2CreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkBufferUsageFlags2CreateInfoKHR
calloc()

Returns a new VkBufferUsageFlags2CreateInfoKHR instance allocated with memCalloc.

public static VkBufferUsageFlags2CreateInfoKHR.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkBufferUsageFlags2CreateInfoKHR.Buffer instance allocated with memCalloc.

public static VkBufferUsageFlags2CreateInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VkBufferUsageFlags2CreateInfoKHR.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

protected VkBufferUsageFlags2CreateInfoKHR
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 VkBufferUsageFlags2CreateInfoKHR
create()

Returns a new VkBufferUsageFlags2CreateInfoKHR instance allocated with BufferUtils.

public static VkBufferUsageFlags2CreateInfoKHR
create(long address)

Returns a new VkBufferUsageFlags2CreateInfoKHR instance for the specified memory address.

public static VkBufferUsageFlags2CreateInfoKHR.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkBufferUsageFlags2CreateInfoKHR.Buffer instance allocated with BufferUtils.

public static VkBufferUsageFlags2CreateInfoKHR.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkBufferUsageFlags2CreateInfoKHR.Buffer instance at the specified memory.

public static VkBufferUsageFlags2CreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkBufferUsageFlags2CreateInfoKHR
malloc()

Returns a new VkBufferUsageFlags2CreateInfoKHR instance allocated with memAlloc.

public static VkBufferUsageFlags2CreateInfoKHR.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkBufferUsageFlags2CreateInfoKHR.Buffer instance allocated with memAlloc.

public static VkBufferUsageFlags2CreateInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkBufferUsageFlags2CreateInfoKHR instance allocated on the specified MemoryStack.

public static VkBufferUsageFlags2CreateInfoKHR.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static long
nusage(long struct)

Unsafe version of usage.

public static void
nusage(long struct, long value)

Unsafe version of usage.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkBufferUsageFlags2CreateInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkBufferUsageFlags2CreateInfoKHR
set(int sType, long pNext, long usage)

Initializes this struct with the specified values.

public VkBufferUsageFlags2CreateInfoKHR

Returns:

this struct
set(VkBufferUsageFlags2CreateInfoKHR
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkBufferUsageFlags2CreateInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkBufferUsageFlags2CreateInfoKHR
sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_USAGE_FLAGS_2_CREATE_INFO_KHR value to the sType field.

public long
usage()

a bitmask of VkBufferUsageFlagBits2KHR specifying allowed usages of the buffer.

public VkBufferUsageFlags2CreateInfoKHR
usage(long value)

Sets the specified value to the usage field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

USAGEback to summary
public static final int USAGE

The struct member offsets.

Constructor Detail

VkBufferUsageFlags2CreateInfoKHRback to summary
protected VkBufferUsageFlags2CreateInfoKHR(long address, ByteBuffer container)
VkBufferUsageFlags2CreateInfoKHRback to summary
public VkBufferUsageFlags2CreateInfoKHR(ByteBuffer container)

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

callocback to summary
public static VkBufferUsageFlags2CreateInfoKHR calloc()

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

callocback to summary
public static VkBufferUsageFlags2CreateInfoKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkBufferUsageFlags2CreateInfoKHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkBufferUsageFlags2CreateInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

createback to summary
protected VkBufferUsageFlags2CreateInfoKHR 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
createback to summary
public static VkBufferUsageFlags2CreateInfoKHR create()

Returns a new VkBufferUsageFlags2CreateInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkBufferUsageFlags2CreateInfoKHR create(long address)

Returns a new VkBufferUsageFlags2CreateInfoKHR instance for the specified memory address.

createback to summary
public static VkBufferUsageFlags2CreateInfoKHR.Buffer create(int capacity)

Returns a new VkBufferUsageFlags2CreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkBufferUsageFlags2CreateInfoKHR.Buffer create(long address, int capacity)

Create a VkBufferUsageFlags2CreateInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkBufferUsageFlags2CreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkBufferUsageFlags2CreateInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkBufferUsageFlags2CreateInfoKHR malloc()

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

mallocback to summary
public static VkBufferUsageFlags2CreateInfoKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkBufferUsageFlags2CreateInfoKHR malloc(MemoryStack stack)

Returns a new VkBufferUsageFlags2CreateInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkBufferUsageFlags2CreateInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

nusageback to summary
public static long nusage(long struct)

Unsafe version of usage.

nusageback to summary
public static void nusage(long struct, long value)

Unsafe version of usage.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkBufferUsageFlags2CreateInfoKHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkBufferUsageFlags2CreateInfoKHR set(int sType, long pNext, long usage)

Initializes this struct with the specified values.

setback to summary
public VkBufferUsageFlags2CreateInfoKHR set(VkBufferUsageFlags2CreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkBufferUsageFlags2CreateInfoKHR

the source struct

Returns:VkBufferUsageFlags2CreateInfoKHR

this struct

sizeofback to summary
public int sizeof()

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

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

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkBufferUsageFlags2CreateInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkBufferUsageFlags2CreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_USAGE_FLAGS_2_CREATE_INFO_KHR value to the sType field.

usageback to summary
public long usage()

a bitmask of VkBufferUsageFlagBits2KHR specifying allowed usages of the buffer.

Annotations
@NativeType:VkBufferUsageFlags2KHR
usageback to summary
public VkBufferUsageFlags2CreateInfoKHR usage(long value)

Sets the specified value to the usage field.

org.lwjgl.vulkan back to summary

public Class VkBufferUsageFlags2CreateInfoKHR.Buffer

extends StructBuffer<VkBufferUsageFlags2CreateInfoKHR, VkBufferUsageFlags2CreateInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkBufferUsageFlags2CreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkBufferUsageFlags2CreateInfoKHR
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkBufferUsageFlags2CreateInfoKHR.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 TypeMethod and Description
protected VkBufferUsageFlags2CreateInfoKHR
getElementFactory()

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

public long

Returns:

the value of the VkBufferUsageFlags2CreateInfoKHR#pNext field.
pNext()

public VkBufferUsageFlags2CreateInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkBufferUsageFlags2CreateInfoKHR#pNext field.

protected VkBufferUsageFlags2CreateInfoKHR.Buffer
self()

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

public int

Returns:

the value of the VkBufferUsageFlags2CreateInfoKHR#sType field.
sType()

public VkBufferUsageFlags2CreateInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkBufferUsageFlags2CreateInfoKHR#sType field.

public VkBufferUsageFlags2CreateInfoKHR.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_USAGE_FLAGS_2_CREATE_INFO_KHR value to the VkBufferUsageFlags2CreateInfoKHR#sType field.

public long

Returns:

the value of the VkBufferUsageFlags2CreateInfoKHR#usage field.
usage()

public VkBufferUsageFlags2CreateInfoKHR.Buffer
usage(long value)

Sets the specified value to the VkBufferUsageFlags2CreateInfoKHR#usage field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkBufferUsageFlags2CreateInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

Method Detail

getElementFactoryback to summary
protected VkBufferUsageFlags2CreateInfoKHR getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkBufferUsageFlags2CreateInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkBufferUsageFlags2CreateInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkBufferUsageFlags2CreateInfoKHR#pNext field.

selfback to summary
protected VkBufferUsageFlags2CreateInfoKHR.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkBufferUsageFlags2CreateInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkBufferUsageFlags2CreateInfoKHR.Buffer sType(int value)

Sets the specified value to the VkBufferUsageFlags2CreateInfoKHR#sType field.

sType$Defaultback to summary
public VkBufferUsageFlags2CreateInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_USAGE_FLAGS_2_CREATE_INFO_KHR value to the VkBufferUsageFlags2CreateInfoKHR#sType field.

usageback to summary
public long usage()
Returns:long

the value of the VkBufferUsageFlags2CreateInfoKHR#usage field.

Annotations
@NativeType:VkBufferUsageFlags2KHR
usageback to summary
public VkBufferUsageFlags2CreateInfoKHR.Buffer usage(long value)

Sets the specified value to the VkBufferUsageFlags2CreateInfoKHR#usage field.