Class VkBufferViewCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBufferViewCreateInfo>

org.lwjgl.vulkan.VkBufferViewCreateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkBufferViewCreateInfo
extends Struct<VkBufferViewCreateInfo>
implements NativeResource

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkBufferViewCreateInfo.Buffer	An array of VkBufferViewCreateInfo structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BUFFER	The struct member offsets.
static final int	FLAGS	The struct member offsets.
static final int	FORMAT	The struct member offsets.
static final int	OFFSET	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	RANGE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
long	buffer()
VkBufferViewCreateInfo	buffer(long value)	Sets the specified value to the buffer field.
static VkBufferViewCreateInfo	calloc()	Returns a new VkBufferViewCreateInfo instance allocated with memCalloc.
static VkBufferViewCreateInfo.Buffer	calloc(int capacity)	Returns a new VkBufferViewCreateInfo.Buffer instance allocated with memCalloc.
static VkBufferViewCreateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkBufferViewCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBufferViewCreateInfo	calloc(MemoryStack stack)	Returns a new VkBufferViewCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBufferViewCreateInfo	create()	Returns a new VkBufferViewCreateInfo instance allocated with BufferUtils.
static VkBufferViewCreateInfo.Buffer	create(int capacity)	Returns a new VkBufferViewCreateInfo.Buffer instance allocated with BufferUtils.
static VkBufferViewCreateInfo	create(long address)	Returns a new VkBufferViewCreateInfo instance for the specified memory address.
static VkBufferViewCreateInfo.Buffer	create(long address, int capacity)	Create a VkBufferViewCreateInfo.Buffer instance at the specified memory.
static @Nullable VkBufferViewCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkBufferViewCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()
VkBufferViewCreateInfo	flags(int value)	Sets the specified value to the flags field.
int	format()
VkBufferViewCreateInfo	format(int value)	Sets the specified value to the format field.
static VkBufferViewCreateInfo	malloc()	Returns a new VkBufferViewCreateInfo instance allocated with memAlloc.
static VkBufferViewCreateInfo.Buffer	malloc(int capacity)	Returns a new VkBufferViewCreateInfo.Buffer instance allocated with memAlloc.
static VkBufferViewCreateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkBufferViewCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkBufferViewCreateInfo	malloc(MemoryStack stack)	Returns a new VkBufferViewCreateInfo instance allocated on the specified MemoryStack.
static long	nbuffer(long struct)	Unsafe version of buffer().
static void	nbuffer(long struct, long value)	Unsafe version of buffer.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static int	nformat(long struct)	Unsafe version of format().
static void	nformat(long struct, int value)	Unsafe version of format.
static long	noffset(long struct)	Unsafe version of offset().
static void	noffset(long struct, long value)	Unsafe version of offset.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static long	nrange(long struct)	Unsafe version of range().
static void	nrange(long struct, long value)	Unsafe version of range.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	offset()
VkBufferViewCreateInfo	offset(long value)	Sets the specified value to the offset field.
long	pNext()
VkBufferViewCreateInfo	pNext(long value)	Sets the specified value to the pNext field.
VkBufferViewCreateInfo	pNext(VkBufferUsageFlags2CreateInfo value)	Prepends the specified VkBufferUsageFlags2CreateInfo value to the pNext chain.
VkBufferViewCreateInfo	pNext(VkBufferUsageFlags2CreateInfoKHR value)	Prepends the specified VkBufferUsageFlags2CreateInfoKHR value to the pNext chain.
VkBufferViewCreateInfo	pNext(VkExportMetalObjectCreateInfoEXT value)	Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pNext chain.
long	range()
VkBufferViewCreateInfo	range(long value)	Sets the specified value to the range field.
VkBufferViewCreateInfo	set(int sType, long pNext, int flags, long buffer, int format, long offset, long range)	Initializes this struct with the specified values.
VkBufferViewCreateInfo	set(VkBufferViewCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkBufferViewCreateInfo	sType(int value)	Sets the specified value to the sType field.
VkBufferViewCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO value to the sType field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

BUFFER

public static final int BUFFER

The struct member offsets.

FORMAT

public static final int FORMAT

The struct member offsets.

OFFSET

public static final int OFFSET

The struct member offsets.

RANGE

public static final int RANGE

The struct member offsets.

Constructor Details

VkBufferViewCreateInfo

public VkBufferViewCreateInfo(ByteBuffer container)

Creates a VkBufferViewCreateInfo 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkBufferViewCreateInfo>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

flags

@NativeType("VkBufferViewCreateFlags")
public int flags()

Returns:

the value of the flags field.

buffer

@NativeType("VkBuffer")
public long buffer()

Returns:

the value of the buffer field.

format

@NativeType("VkFormat")
public int format()

Returns:

the value of the format field.

offset

@NativeType("VkDeviceSize")
public long offset()

Returns:

the value of the offset field.

range

@NativeType("VkDeviceSize")
public long range()

Returns:

the value of the range field.

sType

public VkBufferViewCreateInfo sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkBufferViewCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO value to the sType field.

pNext

public VkBufferViewCreateInfo pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

pNext

public VkBufferViewCreateInfo pNext(VkBufferUsageFlags2CreateInfo value)

Prepends the specified VkBufferUsageFlags2CreateInfo value to the pNext chain.

pNext

public VkBufferViewCreateInfo pNext(VkBufferUsageFlags2CreateInfoKHR value)

Prepends the specified VkBufferUsageFlags2CreateInfoKHR value to the pNext chain.

pNext

public VkBufferViewCreateInfo pNext(VkExportMetalObjectCreateInfoEXT value)

Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pNext chain.

flags

public VkBufferViewCreateInfo flags(@NativeType("VkBufferViewCreateFlags")
 int value)

Sets the specified value to the flags field.

buffer

public VkBufferViewCreateInfo buffer(@NativeType("VkBuffer")
 long value)

Sets the specified value to the buffer field.

format

public VkBufferViewCreateInfo format(@NativeType("VkFormat")
 int value)

Sets the specified value to the format field.

offset

public VkBufferViewCreateInfo offset(@NativeType("VkDeviceSize")
 long value)

Sets the specified value to the offset field.

range

public VkBufferViewCreateInfo range(@NativeType("VkDeviceSize")
 long value)

Sets the specified value to the range field.

set

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

Initializes this struct with the specified values.

set

public VkBufferViewCreateInfo set(VkBufferViewCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBufferViewCreateInfo malloc()

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

calloc

public static VkBufferViewCreateInfo calloc()

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

create

public static VkBufferViewCreateInfo create()

Returns a new VkBufferViewCreateInfo instance allocated with BufferUtils.

create

public static VkBufferViewCreateInfo create(long address)

Returns a new VkBufferViewCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkBufferViewCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBufferViewCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBufferViewCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBufferViewCreateInfo.Buffer create(int capacity)

Returns a new VkBufferViewCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBufferViewCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkBufferViewCreateInfo malloc(MemoryStack stack)

Returns a new VkBufferViewCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkBufferViewCreateInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nbuffer

public static long nbuffer(long struct)

Unsafe version of buffer().

nformat

public static int nformat(long struct)

Unsafe version of format().

noffset

public static long noffset(long struct)

Unsafe version of offset().

nrange

public static long nrange(long struct)

Unsafe version of range().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

nbuffer

public static void nbuffer(long struct,
 long value)

Unsafe version of buffer.

nformat

public static void nformat(long struct,
 int value)

Unsafe version of format.

noffset

public static void noffset(long struct,
 long value)

Unsafe version of offset.

nrange

public static void nrange(long struct,
 long value)

Unsafe version of range.