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

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

public class VkImageMemoryBarrier
extends Struct

Khronos Reference Page
Vulkan Specification

Specifies an image memory barrier. This type of barrier only applies to memory accesses involving a specific image subresource range of the specified image object. That is, a memory dependency formed from an image memory barrier is scoped to the specified subresources of the image. It is also used to perform a layout transition for an image subresource range, or to transfer ownership of an image subresource range from one queue family to another.

Valid Usage

sType must be STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
pNext must be NULL
srcAccessMask must be a valid combination of VkAccessFlagBits values
dstAccessMask must be a valid combination of VkAccessFlagBits values
oldLayout must be a valid VkImageLayout value
newLayout must be a valid VkImageLayout value
image must be a valid VkImage handle
subresourceRange must be a valid VkImageSubresourceRange structure
oldLayout must be IMAGE_LAYOUT_UNDEFINED, IMAGE_LAYOUT_PREINITIALIZED or the current layout of the image region affected by the barrier
newLayout must not be IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZED
If image was created with a sharing mode of SHARING_MODE_CONCURRENT, srcQueueFamilyIndex and dstQueueFamilyIndex must both be QUEUE_FAMILY_IGNORED
If image 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 image 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
subresourceRange must be a valid image subresource range for the image
If image has a depth/stencil format with both depth and stencil components, then aspectMask member of subresourceRange must include both IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
If either oldLayout or newLayout is IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL then image must have been created with IMAGE_USAGE_COLOR_ATTACHMENT_BIT set
If either oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL then image must have been created with IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
If either oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL then image must have been created with IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
If either oldLayout or newLayout is IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL then image must have been created with IMAGE_USAGE_SAMPLED_BIT or IMAGE_USAGE_INPUT_ATTACHMENT_BIT set
If either oldLayout or newLayout is IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL then image must have been created with IMAGE_USAGE_TRANSFER_SRC_BIT set
If either oldLayout or newLayout is IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL then image must have been created with IMAGE_USAGE_TRANSFER_DST_BIT set

Member documentation

sType – the type of this structure. Must be: STRUCTURE_TYPE_IMAGE_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

oldLayout – describes the current layout of the image subresource(s). One of:

`IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL`	`IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL`
`IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL`	`IMAGE_LAYOUT_GENERAL`
`IMAGE_LAYOUT_PREINITIALIZED`	`IMAGE_LAYOUT_PRESENT_SRC_KHR`
`IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL`	`IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL`
`IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL`	`IMAGE_LAYOUT_UNDEFINED`

newLayout – describes the new layout of the image subresource(s)
srcQueueFamilyIndex – the queue family that is relinquishing ownership of the image subresource(s) to another queue, or QUEUE_FAMILY_IGNORED if there is no transfer of ownership)
dstQueueFamilyIndex – the queue family that is acquiring ownership of the image subresource(s) from another queue, or QUEUE_FAMILY_IGNORED if there is no transfer of ownership)
image – a handle to the image whose backing memory is affected by the barrier
subresourceRange – describes an area of the backing memory for image, as well as the set of image subresources whose image layouts are modified

Layout

struct VkImageMemoryBarrier {
    VkStructureType sType;
    const void * pNext;
    VkAccessFlags srcAccessMask;
    VkAccessFlags dstAccessMask;
    VkImageLayout oldLayout;
    VkImageLayout newLayout;
    uint32_t srcQueueFamilyIndex;
    uint32_t dstQueueFamilyIndex;
    VkImage image;
    VkImageSubresourceRange subresourceRange;
}

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

VkImageMemoryBarrier

Method Detail

sizeof

sType

pNext

srcAccessMask

dstAccessMask

oldLayout

newLayout

srcQueueFamilyIndex

dstQueueFamilyIndex

image

subresourceRange

sType

pNext

srcAccessMask

dstAccessMask

oldLayout

newLayout

srcQueueFamilyIndex

dstQueueFamilyIndex

image

subresourceRange

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack