org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBufferViewCreateInfo>

org.lwjgl.vulkan.VkBufferViewCreateInfo

All Implemented Interfaces:: AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkBufferViewCreateInfo extends org.lwjgl.system.Struct<VkBufferViewCreateInfo> implements org.lwjgl.system.NativeResource

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 VkBufferUsageFlags2CreateInfo 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

offset must be less than the size of buffer
If range is not equal to WHOLE_SIZE, range must be greater than 0
If range is not equal to WHOLE_SIZE, range must be an integer multiple of the texel block size of format
If range is not equal to WHOLE_SIZE, the number of texel buffer elements given by (⌊range / (texel block size)⌋ × (texels per block)) where texel block size and texels per block are as defined in the Compatible Formats table for format, must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
If range is not equal to WHOLE_SIZE, the sum of offset and range must be less than or equal to the size of buffer
If range is equal to WHOLE_SIZE, the number of texel buffer elements given by (⌊(size - offset) / (texel block size)⌋ × (texels per block)) where size is the size of buffer, and texel block size and texels per block are as defined in the Compatible Formats table for format, must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
buffer must have been created with a usage value containing at least one of BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT or BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT
If the buffer view usage contains BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, then format features of format must contain FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT
If the buffer view usage contains BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, then format features of format must contain FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT
If buffer is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object
If the texelBufferAlignment feature is not enabled, offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
If the texelBufferAlignment feature is enabled and if buffer was created with usage containing BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, offset must be a multiple of the lesser of VkPhysicalDeviceTexelBufferAlignmentProperties::storageTexelBufferOffsetAlignmentBytes or, if VkPhysicalDeviceTexelBufferAlignmentProperties::storageTexelBufferOffsetSingleTexelAlignment is TRUE, the size of a texel of the requested format. If the size of a texel is a multiple of three bytes, then the size of a single component of format is used instead
If the texelBufferAlignment feature is enabled and if buffer was created with usage containing BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, offset must be a multiple of the lesser of VkPhysicalDeviceTexelBufferAlignmentProperties::uniformTexelBufferOffsetAlignmentBytes or, if VkPhysicalDeviceTexelBufferAlignmentProperties::uniformTexelBufferOffsetSingleTexelAlignment is TRUE, the size of a texel of the requested format. If the size of a texel is a multiple of three bytes, then the size of a single component of format is used instead
If the pNext chain includes a VkExportMetalObjectCreateInfoEXT structure, its exportObjectType member must be EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT
If the pNext chain includes a VkBufferUsageFlags2CreateInfo, its usage must not contain any other bit than BUFFER_USAGE_2_UNIFORM_TEXEL_BUFFER_BIT or BUFFER_USAGE_2_STORAGE_TEXEL_BUFFER_BIT
If the pNext chain includes a VkBufferUsageFlags2CreateInfo, its usage must be a subset of the VkBufferCreateInfo::usage specified or VkBufferUsageFlags2CreateInfo::usage from VkBufferCreateInfo::pNext when creating buffer

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO
Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkBufferUsageFlags2CreateInfo or VkExportMetalObjectCreateInfoEXT
The sType value of each struct in the pNext chain must be unique, with the exception of structures of type VkExportMetalObjectCreateInfoEXT
flags must be 0
buffer must be a valid VkBuffer handle
format must be a valid VkFormat value

Layout


 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 org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.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 org.lwjgl.system.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()

a VkBuffer on which the view will be created.

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, org.lwjgl.system.MemoryStack stack)

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

static VkBufferViewCreateInfo

calloc(org.lwjgl.system.MemoryStack stack)

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

static VkBufferViewCreateInfo

callocStack()

Deprecated.

static VkBufferViewCreateInfo.Buffer

callocStack(int capacity)

Deprecated.

static VkBufferViewCreateInfo.Buffer

callocStack(int capacity, org.lwjgl.system.MemoryStack stack)

Deprecated.

static VkBufferViewCreateInfo

callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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()

reserved for future use.

VkBufferViewCreateInfo

flags(int value)

Sets the specified value to the flags() field.

int

format()

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

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, org.lwjgl.system.MemoryStack stack)

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

static VkBufferViewCreateInfo

malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkBufferViewCreateInfo instance allocated on the specified MemoryStack.

static VkBufferViewCreateInfo

mallocStack()

Deprecated.

static VkBufferViewCreateInfo.Buffer

mallocStack(int capacity)

Deprecated.

static VkBufferViewCreateInfo.Buffer

mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)

Deprecated.

static VkBufferViewCreateInfo

mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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()

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

VkBufferViewCreateInfo

offset(long value)

Sets the specified value to the offset() field.

long

pNext()

NULL or a pointer to a structure extending this structure.

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()

a size in bytes of the buffer view.

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()

int

sType()

a VkStructureType value identifying this structure.

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 org.lwjgl.system.Struct
clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.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()
  
  Specified by:
  
  sizeof in class org.lwjgl.system.Struct<VkBufferViewCreateInfo>
- sType
  
  public int sType()
  
  a VkStructureType value identifying this structure.
- pNext
  
  public long pNext()
  
  NULL or a pointer to a structure extending this structure.
- flags
  
  public int flags()
  
  reserved for future use.
- buffer
  
  public long buffer()
  
  a VkBuffer on which the view will be created.
- format
  
  public int format()
  
  a VkFormat describing the format of the data elements in the buffer.
- offset
  
  public long offset()
  
  an offset in bytes from the base address of the buffer. Accesses to the buffer view from shaders use addressing that is relative to this starting offset.
- range
  
  public long range()
  
  a size in bytes of the buffer view. If range is equal to WHOLE_SIZE, the range from offset to the end of the buffer is used. If WHOLE_SIZE is used and the remaining size of the buffer is not a multiple of the texel block size of format, the nearest smaller multiple is used.
- sType
  
  public VkBufferViewCreateInfo sType(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(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(int value)
  
  Sets the specified value to the flags() field.
- buffer
  
  public VkBufferViewCreateInfo buffer(long value)
  
  Sets the specified value to the buffer() field.
- format
  
  public VkBufferViewCreateInfo format(int value)
  
  Sets the specified value to the format() field.
- offset
  
  public VkBufferViewCreateInfo offset(long value)
  
  Sets the specified value to the offset() field.
- range
  
  public VkBufferViewCreateInfo range(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.
- mallocStack
  
  @Deprecated public static VkBufferViewCreateInfo mallocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkBufferViewCreateInfo callocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkBufferViewCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkBufferViewCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkBufferViewCreateInfo.Buffer mallocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkBufferViewCreateInfo.Buffer callocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkBufferViewCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkBufferViewCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- malloc
  
  public static VkBufferViewCreateInfo malloc(org.lwjgl.system.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(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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.

Class VkBufferViewCreateInfo

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Details

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

BUFFER

FORMAT

OFFSET

RANGE

Constructor Details

VkBufferViewCreateInfo

Method Details

sizeof

sType

pNext

flags

buffer

format

offset

range

sType

sType$Default

pNext

pNext

pNext

pNext

flags

buffer

format

offset

range

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nsType

npNext

nflags

nbuffer

nformat

noffset

nrange