java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkBufferMemoryBarrier

All Implemented Interfaces:: java.lang.AutoCloseable, NativeResource, Pointer

public class VkBufferMemoryBarrier
extends Struct

Khronos Reference Page
Vulkan Specification

Specifies a buffer memory barrier. This type of barrier only applies to memory accesses involving a specific range of the specified buffer object. That is, a memory dependency formed from a buffer memory barrier is scoped to the specified range of the buffer. It is also used to transfer ownership of a buffer range from one queue family to another.

Valid Usage

sType must be STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER
pNext must be NULL
srcAccessMask must be a valid combination of VkAccessFlagBits values
dstAccessMask must be a valid combination of VkAccessFlagBits values
buffer must be a valid VkBuffer handle
offset must be less than the size of buffer
If size is not equal to WHOLE_SIZE, size must be greater than 0
If size is not equal to WHOLE_SIZE, size must be less than or equal to than the size of buffer minus offset
If buffer was created with a sharing mode of SHARING_MODE_CONCURRENT, srcQueueFamilyIndex and dstQueueFamilyIndex must both be QUEUE_FAMILY_IGNORED
If buffer was created with a sharing mode of SHARING_MODE_EXCLUSIVE, srcQueueFamilyIndex and dstQueueFamilyIndex must either both be QUEUE_FAMILY_IGNORED, or both be a valid queue family
If buffer was created with a sharing mode of SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex and dstQueueFamilyIndex are valid queue families, at least one of them must be the same as the family of the queue that will execute this barrier

Member documentation

sType – the type of this structure. Must be: STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER
pNext – reserved for use by extensions

srcAccessMask – a bitmask of the classes of memory accesses performed by the first set of commands that will participate in the dependency. One or more of:

`ACCESS_COLOR_ATTACHMENT_READ_BIT`	`ACCESS_COLOR_ATTACHMENT_WRITE_BIT`
`ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT`	`ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT`
`ACCESS_HOST_READ_BIT`	`ACCESS_HOST_WRITE_BIT`
`ACCESS_INDEX_READ_BIT`	`ACCESS_INDIRECT_COMMAND_READ_BIT`
`ACCESS_INPUT_ATTACHMENT_READ_BIT`	`ACCESS_MEMORY_READ_BIT`
`ACCESS_MEMORY_WRITE_BIT`	`ACCESS_SHADER_READ_BIT`
`ACCESS_SHADER_WRITE_BIT`	`ACCESS_TRANSFER_READ_BIT`
`ACCESS_TRANSFER_WRITE_BIT`	`ACCESS_UNIFORM_READ_BIT`
`ACCESS_VERTEX_ATTRIBUTE_READ_BIT`

dstAccessMask – a bitmask of the classes of memory accesses performed by the second set of commands that will participate in the dependency
srcQueueFamilyIndex – the queue family that is relinquishing ownership of the range of buffer to another queue, or QUEUE_FAMILY_IGNORED if there is no transfer of ownership
dstQueueFamilyIndex – the queue family that is acquiring ownership of the range of buffer from another queue, or QUEUE_FAMILY_IGNORED if there is no transfer of ownership
buffer – a handle to the buffer whose backing memory is affected by the barrier
offset – an offset in bytes into the backing memory for buffer; this is relative to the base offset as bound to the buffer
size – a size in bytes of the affected area of backing memory for buffer, or WHOLE_SIZE to use the range from offset to the end of the buffer

Layout

struct VkBufferMemoryBarrier {
    VkStructureType sType;
    const void * pNext;
    VkAccessFlags srcAccessMask;
    VkAccessFlags dstAccessMask;
    uint32_t srcQueueFamilyIndex;
    uint32_t dstQueueFamilyIndex;
    VkBuffer buffer;
    VkDeviceSize offset;
    VkDeviceSize size;
}

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkBufferMemoryBarrier.Buffer
An array of VkBufferMemoryBarrier structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  Pointer.Default

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkBufferMemoryBarrier(java.nio.ByteBuffer container)` Creates a `VkBufferMemoryBarrier` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`buffer()` Returns the value of the `buffer` field.
`VkBufferMemoryBarrier`	`buffer(long value)` Sets the specified value to the `buffer` field.
`static VkBufferMemoryBarrier`	`calloc()` Returns a new `VkBufferMemoryBarrier` instance allocated with `memCalloc`.
`static VkBufferMemoryBarrier.Buffer`	`calloc(int capacity)` Returns a new `VkBufferMemoryBarrier.Buffer` instance allocated with `memCalloc`.
`static VkBufferMemoryBarrier`	`callocStack()` Returns a new `VkBufferMemoryBarrier` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBufferMemoryBarrier.Buffer`	`callocStack(int capacity)` Returns a new `VkBufferMemoryBarrier.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBufferMemoryBarrier.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkBufferMemoryBarrier.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBufferMemoryBarrier`	`callocStack(MemoryStack stack)` Returns a new `VkBufferMemoryBarrier` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBufferMemoryBarrier`	`create()` Returns a new `VkBufferMemoryBarrier` instance allocated with `BufferUtils`.
`static VkBufferMemoryBarrier.Buffer`	`create(int capacity)` Returns a new `VkBufferMemoryBarrier.Buffer` instance allocated with `BufferUtils`.
`static VkBufferMemoryBarrier`	`create(long address)` Returns a new `VkBufferMemoryBarrier` instance for the specified memory address or `null` if the address is `NULL`.
`static VkBufferMemoryBarrier.Buffer`	`create(long address, int capacity)` Create a `VkBufferMemoryBarrier.Buffer` instance at the specified memory.
`int`	`dstAccessMask()` Returns the value of the `dstAccessMask` field.
`VkBufferMemoryBarrier`	`dstAccessMask(int value)` Sets the specified value to the `dstAccessMask` field.
`int`	`dstQueueFamilyIndex()` Returns the value of the `dstQueueFamilyIndex` field.
`VkBufferMemoryBarrier`	`dstQueueFamilyIndex(int value)` Sets the specified value to the `dstQueueFamilyIndex` field.
`static VkBufferMemoryBarrier`	`malloc()` Returns a new `VkBufferMemoryBarrier` instance allocated with `memAlloc`.
`static VkBufferMemoryBarrier.Buffer`	`malloc(int capacity)` Returns a new `VkBufferMemoryBarrier.Buffer` instance allocated with `memAlloc`.
`static VkBufferMemoryBarrier`	`mallocStack()` Returns a new `VkBufferMemoryBarrier` instance allocated on the thread-local `MemoryStack`.
`static VkBufferMemoryBarrier.Buffer`	`mallocStack(int capacity)` Returns a new `VkBufferMemoryBarrier.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkBufferMemoryBarrier.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkBufferMemoryBarrier.Buffer` instance allocated on the specified `MemoryStack`.
`static VkBufferMemoryBarrier`	`mallocStack(MemoryStack stack)` Returns a new `VkBufferMemoryBarrier` instance allocated on the specified `MemoryStack`.
`VkBufferMemoryBarrier`	`nset(long struct)` Unsafe version of `set`.
`long`	`offset()` Returns the value of the `offset` field.
`VkBufferMemoryBarrier`	`offset(long value)` Sets the specified value to the `offset` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkBufferMemoryBarrier`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkBufferMemoryBarrier`	`set(int sType, long pNext, int srcAccessMask, int dstAccessMask, int srcQueueFamilyIndex, int dstQueueFamilyIndex, long buffer, long offset, long size)` Initializes this struct with the specified values.
`VkBufferMemoryBarrier`	`set(VkBufferMemoryBarrier src)` Copies the specified struct data to this struct.
`long`	`size()` Returns the value of the `size` field.
`VkBufferMemoryBarrier`	`size(long value)` Sets the specified value to the `size` field.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`int`	`srcAccessMask()` Returns the value of the `srcAccessMask` field.
`VkBufferMemoryBarrier`	`srcAccessMask(int value)` Sets the specified value to the `srcAccessMask` field.
`int`	`srcQueueFamilyIndex()` Returns the value of the `srcQueueFamilyIndex` field.
`VkBufferMemoryBarrier`	`srcQueueFamilyIndex(int value)` Sets the specified value to the `srcQueueFamilyIndex` field.
`int`	`sType()` Returns the value of the `sType` field.
`VkBufferMemoryBarrier`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- Constructor Detail
  - VkBufferMemoryBarrier
```
public VkBufferMemoryBarrier(java.nio.ByteBuffer container)
```
    Creates a VkBufferMemoryBarrier 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
  - sizeof
```
public int sizeof()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - srcAccessMask
```
public int srcAccessMask()
```
    Returns the value of the srcAccessMask field.
  - dstAccessMask
```
public int dstAccessMask()
```
    Returns the value of the dstAccessMask field.
  - srcQueueFamilyIndex
```
public int srcQueueFamilyIndex()
```
    Returns the value of the srcQueueFamilyIndex field.
  - dstQueueFamilyIndex
```
public int dstQueueFamilyIndex()
```
    Returns the value of the dstQueueFamilyIndex field.
  - buffer
```
public long buffer()
```
    Returns the value of the buffer field.
  - offset
```
public long offset()
```
    Returns the value of the offset field.
  - size
```
public long size()
```
    Returns the value of the size field.
  - sType
```
public VkBufferMemoryBarrier sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkBufferMemoryBarrier pNext(long value)
```
    Sets the specified value to the pNext field.
  - srcAccessMask
```
public VkBufferMemoryBarrier srcAccessMask(int value)
```
    Sets the specified value to the srcAccessMask field.
  - dstAccessMask
```
public VkBufferMemoryBarrier dstAccessMask(int value)
```
    Sets the specified value to the dstAccessMask field.
  - srcQueueFamilyIndex
```
public VkBufferMemoryBarrier srcQueueFamilyIndex(int value)
```
    Sets the specified value to the srcQueueFamilyIndex field.
  - dstQueueFamilyIndex
```
public VkBufferMemoryBarrier dstQueueFamilyIndex(int value)
```
    Sets the specified value to the dstQueueFamilyIndex field.
  - buffer
```
public VkBufferMemoryBarrier buffer(long value)
```
    Sets the specified value to the buffer field.
  - offset
```
public VkBufferMemoryBarrier offset(long value)
```
    Sets the specified value to the offset field.
  - size
```
public VkBufferMemoryBarrier size(long value)
```
    Sets the specified value to the size field.
  - set
```
public VkBufferMemoryBarrier set(int sType,
                                 long pNext,
                                 int srcAccessMask,
                                 int dstAccessMask,
                                 int srcQueueFamilyIndex,
                                 int dstQueueFamilyIndex,
                                 long buffer,
                                 long offset,
                                 long size)
```
    Initializes this struct with the specified values.
  - nset
```
public VkBufferMemoryBarrier nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkBufferMemoryBarrier set(VkBufferMemoryBarrier src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkBufferMemoryBarrier malloc()
```
    Returns a new VkBufferMemoryBarrier instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkBufferMemoryBarrier calloc()
```
    Returns a new VkBufferMemoryBarrier instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkBufferMemoryBarrier create()
```
    Returns a new VkBufferMemoryBarrier instance allocated with BufferUtils.
  - create
```
public static VkBufferMemoryBarrier create(long address)
```
    Returns a new VkBufferMemoryBarrier instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkBufferMemoryBarrier.Buffer malloc(int capacity)
```
    Returns a new VkBufferMemoryBarrier.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkBufferMemoryBarrier.Buffer calloc(int capacity)
```
    Returns a new VkBufferMemoryBarrier.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBufferMemoryBarrier.Buffer create(int capacity)
```
    Returns a new VkBufferMemoryBarrier.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBufferMemoryBarrier.Buffer create(long address,
                                                  int capacity)
```
    Create a VkBufferMemoryBarrier.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkBufferMemoryBarrier mallocStack()
```
    Returns a new VkBufferMemoryBarrier instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkBufferMemoryBarrier callocStack()
```
    Returns a new VkBufferMemoryBarrier instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkBufferMemoryBarrier mallocStack(MemoryStack stack)
```
    Returns a new VkBufferMemoryBarrier instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkBufferMemoryBarrier callocStack(MemoryStack stack)
```
    Returns a new VkBufferMemoryBarrier instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkBufferMemoryBarrier.Buffer mallocStack(int capacity)
```
    Returns a new VkBufferMemoryBarrier.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBufferMemoryBarrier.Buffer callocStack(int capacity)
```
    Returns a new VkBufferMemoryBarrier.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkBufferMemoryBarrier.Buffer mallocStack(int capacity,
                                                       MemoryStack stack)
```
    Returns a new VkBufferMemoryBarrier.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBufferMemoryBarrier.Buffer callocStack(int capacity,
                                                       MemoryStack stack)
```
    Returns a new VkBufferMemoryBarrier.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity

Class VkBufferMemoryBarrier

Valid Usage

Member documentation

Layout

Nested Class Summary

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 Detail

SIZEOF

Constructor Detail

VkBufferMemoryBarrier

Method Detail

sizeof

sType

pNext

srcAccessMask

dstAccessMask

srcQueueFamilyIndex

dstQueueFamilyIndex

buffer

offset

size

sType

pNext

srcAccessMask

dstAccessMask

srcQueueFamilyIndex

dstQueueFamilyIndex

buffer

offset

size

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack