Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBufferViewCreateInfo

extends Struct<VkBufferViewCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying parameters of a newly created buffer view.
Description

The buffer view has a buffer view usage identifying which descriptor types can be created from it. This usage can be defined by including the VkBufferUsageFlags2CreateInfoKHR structure in the pNext chain, and specifying the usage value there. If this structure is not included, it is equal to the VkBufferCreateInfo::usage value used to create buffer.

Valid Usage
Valid Usage (Implicit)
See Also

CreateBufferView

Layout


struct VkBufferViewCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkBufferViewCreateFlags flags;
    VkBuffer buffer;
    VkFormat format;
    VkDeviceSize offset;
    VkDeviceSize range;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BUFFER

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
FORMAT

The struct member offsets.

public static final int
OFFSET

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
RANGE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkBufferViewCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
buffer()

a VkBuffer on which the view will be created.

public VkBufferViewCreateInfo
buffer(long value)

Sets the specified value to the buffer field.

public static VkBufferViewCreateInfo
calloc()

Returns a new VkBufferViewCreateInfo instance allocated with memCalloc.

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

Returns a new VkBufferViewCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkBufferViewCreateInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkBufferViewCreateInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBufferViewCreateInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBufferViewCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkBufferViewCreateInfo
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 VkBufferViewCreateInfo
create()

Returns a new VkBufferViewCreateInfo instance allocated with BufferUtils.

public static VkBufferViewCreateInfo
create(long address)

Returns a new VkBufferViewCreateInfo instance for the specified memory address.

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

Returns a new VkBufferViewCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkBufferViewCreateInfo.Buffer instance at the specified memory.

public static VkBufferViewCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

reserved for future use.

public VkBufferViewCreateInfo
flags(int value)

Sets the specified value to the flags field.

public int
format()

a VkFormat describing the format of the data elements in the buffer.

public VkBufferViewCreateInfo
format(int value)

Sets the specified value to the format field.

public static VkBufferViewCreateInfo
malloc()

Returns a new VkBufferViewCreateInfo instance allocated with memAlloc.

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

Returns a new VkBufferViewCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkBufferViewCreateInfo instance allocated on the specified MemoryStack.

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

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

public static VkBufferViewCreateInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkBufferViewCreateInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBufferViewCreateInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBufferViewCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
nbuffer(long struct)

Unsafe version of buffer.

public static void
nbuffer(long struct, long value)

Unsafe version of buffer.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static int
nformat(long struct)

Unsafe version of format.

public static void
nformat(long struct, int value)

Unsafe version of format.

public static long
noffset(long struct)

Unsafe version of offset.

public static void
noffset(long struct, long value)

Unsafe version of offset.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static long
nrange(long struct)

Unsafe version of range.

public static void
nrange(long struct, long value)

Unsafe version of range.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
offset()

an offset in bytes from the base address of the buffer.

public VkBufferViewCreateInfo
offset(long value)

Sets the specified value to the offset field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkBufferViewCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkBufferViewCreateInfo
pNext(VkBufferUsageFlags2CreateInfoKHR value)

Prepends the specified VkBufferUsageFlags2CreateInfoKHR value to the pNext chain.

public VkBufferViewCreateInfo
pNext(VkExportMetalObjectCreateInfoEXT value)

Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pNext chain.

public long
range()

a size in bytes of the buffer view.

public VkBufferViewCreateInfo
range(long value)

Sets the specified value to the range field.

public VkBufferViewCreateInfo
set(int sType, long pNext, int flags, long buffer, int format, long offset, long range)

Initializes this struct with the specified values.

public VkBufferViewCreateInfo

Returns:

this struct
set
(VkBufferViewCreateInfo
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 VkBufferViewCreateInfo
sType(int value)

Sets the specified value to the sType field.

public VkBufferViewCreateInfo
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate