Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMemoryBarrier

extends Struct<VkMemoryBarrier>
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 a global memory barrier.
Description

The first access scope is limited to access types in the source access mask specified by srcAccessMask.

The second access scope is limited to access types in the destination access mask specified by dstAccessMask.

Valid Usage (Implicit)
See Also

CmdPipelineBarrier, CmdWaitEvents

Layout


struct VkMemoryBarrier {
    VkStructureType sType;
    void const * pNext;
    VkAccessFlags srcAccessMask;
    VkAccessFlags dstAccessMask;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkMemoryBarrier.Buffer

An array of VkMemoryBarrier structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DSTACCESSMASK

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SRCACCESSMASK

The struct member offsets.

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
VkMemoryBarrier(long address, ByteBuffer container)

public
VkMemoryBarrier(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkMemoryBarrier
calloc()

Returns a new VkMemoryBarrier instance allocated with memCalloc.

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

Returns a new VkMemoryBarrier.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkMemoryBarrier
callocStack()

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

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

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

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

Returns a new VkMemoryBarrier instance allocated with BufferUtils.

public static VkMemoryBarrier
create(long address)

Returns a new VkMemoryBarrier instance for the specified memory address.

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

Returns a new VkMemoryBarrier.Buffer instance allocated with BufferUtils.

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

Create a VkMemoryBarrier.Buffer instance at the specified memory.

public static VkMemoryBarrier
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
dstAccessMask()

a bitmask of VkAccessFlagBits specifying a destination access mask.

public VkMemoryBarrier
dstAccessMask(int value)

Sets the specified value to the dstAccessMask field.

public static VkMemoryBarrier
malloc()

Returns a new VkMemoryBarrier instance allocated with memAlloc.

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

Returns a new VkMemoryBarrier.Buffer instance allocated with memAlloc.

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

Returns a new VkMemoryBarrier instance allocated on the specified MemoryStack.

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

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

public static VkMemoryBarrier
mallocStack()

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

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

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

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

Unsafe version of dstAccessMask.

public static void
ndstAccessMask(long struct, int value)

Unsafe version of dstAccessMask.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsrcAccessMask(long struct)

Unsafe version of srcAccessMask.

public static void
nsrcAccessMask(long struct, int value)

Unsafe version of srcAccessMask.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkMemoryBarrier
pNext(long value)

Sets the specified value to the pNext field.

public VkMemoryBarrier
set(int sType, long pNext, int srcAccessMask, int dstAccessMask)

Initializes this struct with the specified values.

public VkMemoryBarrier

Returns:

this struct
set(VkMemoryBarrier
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
srcAccessMask()

a bitmask of VkAccessFlagBits specifying a source access mask.

public VkMemoryBarrier
srcAccessMask(int value)

Sets the specified value to the srcAccessMask field.

public int
sType()

a VkStructureType value identifying this structure.

public VkMemoryBarrier
sType(int value)

Sets the specified value to the sType field.

public VkMemoryBarrier
sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_BARRIER value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DSTACCESSMASKback to summary
public static final int DSTACCESSMASK

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SRCACCESSMASKback to summary
public static final int SRCACCESSMASK

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkMemoryBarrierback to summary
protected VkMemoryBarrier(long address, ByteBuffer container)
VkMemoryBarrierback to summary
public VkMemoryBarrier(ByteBuffer container)

Creates a VkMemoryBarrier 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

callocback to summary
public static VkMemoryBarrier calloc()

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

callocback to summary
public static VkMemoryBarrier.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMemoryBarrier calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkMemoryBarrier.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkMemoryBarrier callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryBarrier callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryBarrier.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryBarrier.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkMemoryBarrier create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkMemoryBarrier create()

Returns a new VkMemoryBarrier instance allocated with BufferUtils.

createback to summary
public static VkMemoryBarrier create(long address)

Returns a new VkMemoryBarrier instance for the specified memory address.

createback to summary
public static VkMemoryBarrier.Buffer create(int capacity)

Returns a new VkMemoryBarrier.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkMemoryBarrier.Buffer create(long address, int capacity)

Create a VkMemoryBarrier.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMemoryBarrier createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkMemoryBarrier.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
dstAccessMaskback to summary
public int dstAccessMask()

a bitmask of VkAccessFlagBits specifying a destination access mask.

Annotations
@NativeType:VkAccessFlags
dstAccessMaskback to summary
public VkMemoryBarrier dstAccessMask(int value)

Sets the specified value to the dstAccessMask field.

mallocback to summary
public static VkMemoryBarrier malloc()

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

mallocback to summary
public static VkMemoryBarrier.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMemoryBarrier malloc(MemoryStack stack)

Returns a new VkMemoryBarrier instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkMemoryBarrier.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkMemoryBarrier mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryBarrier mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryBarrier.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryBarrier.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
ndstAccessMaskback to summary
public static int ndstAccessMask(long struct)

Unsafe version of dstAccessMask.

ndstAccessMaskback to summary
public static void ndstAccessMask(long struct, int value)

Unsafe version of dstAccessMask.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsrcAccessMaskback to summary
public static int nsrcAccessMask(long struct)

Unsafe version of srcAccessMask.

nsrcAccessMaskback to summary
public static void nsrcAccessMask(long struct, int value)

Unsafe version of srcAccessMask.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkMemoryBarrier pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkMemoryBarrier set(int sType, long pNext, int srcAccessMask, int dstAccessMask)

Initializes this struct with the specified values.

setback to summary
public VkMemoryBarrier set(VkMemoryBarrier src)

Copies the specified struct data to this struct.

Parameters
src:VkMemoryBarrier

the source struct

Returns:VkMemoryBarrier

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
srcAccessMaskback to summary
public int srcAccessMask()

a bitmask of VkAccessFlagBits specifying a source access mask.

Annotations
@NativeType:VkAccessFlags
srcAccessMaskback to summary
public VkMemoryBarrier srcAccessMask(int value)

Sets the specified value to the srcAccessMask field.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkMemoryBarrier sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkMemoryBarrier sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_BARRIER value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkMemoryBarrier.Buffer

extends StructBuffer<VkMemoryBarrier, VkMemoryBarrier.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkMemoryBarrier structs.

Field Summary

Modifier and TypeField and Description
private static final VkMemoryBarrier
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMemoryBarrier.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkMemoryBarrier#dstAccessMask field.
dstAccessMask()

public VkMemoryBarrier.Buffer
dstAccessMask(int value)

Sets the specified value to the VkMemoryBarrier#dstAccessMask field.

protected VkMemoryBarrier
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public long

Returns:

the value of the VkMemoryBarrier#pNext field.
pNext()

public VkMemoryBarrier.Buffer
pNext(long value)

Sets the specified value to the VkMemoryBarrier#pNext field.

protected VkMemoryBarrier.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkMemoryBarrier#srcAccessMask field.
srcAccessMask()

public VkMemoryBarrier.Buffer
srcAccessMask(int value)

Sets the specified value to the VkMemoryBarrier#srcAccessMask field.

public int

Returns:

the value of the VkMemoryBarrier#sType field.
sType()

public VkMemoryBarrier.Buffer
sType(int value)

Sets the specified value to the VkMemoryBarrier#sType field.

public VkMemoryBarrier.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_BARRIER value to the VkMemoryBarrier#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMemoryBarrier ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkMemoryBarrier.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkMemoryBarrier#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

dstAccessMaskback to summary
public int dstAccessMask()
Returns:int

the value of the VkMemoryBarrier#dstAccessMask field.

Annotations
@NativeType:VkAccessFlags
dstAccessMaskback to summary
public VkMemoryBarrier.Buffer dstAccessMask(int value)

Sets the specified value to the VkMemoryBarrier#dstAccessMask field.

getElementFactoryback to summary
protected VkMemoryBarrier getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkMemoryBarrier#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkMemoryBarrier.Buffer pNext(long value)

Sets the specified value to the VkMemoryBarrier#pNext field.

selfback to summary
protected VkMemoryBarrier.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
srcAccessMaskback to summary
public int srcAccessMask()
Returns:int

the value of the VkMemoryBarrier#srcAccessMask field.

Annotations
@NativeType:VkAccessFlags
srcAccessMaskback to summary
public VkMemoryBarrier.Buffer srcAccessMask(int value)

Sets the specified value to the VkMemoryBarrier#srcAccessMask field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkMemoryBarrier#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkMemoryBarrier.Buffer sType(int value)

Sets the specified value to the VkMemoryBarrier#sType field.

sType$Defaultback to summary
public VkMemoryBarrier.Buffer sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_BARRIER value to the VkMemoryBarrier#sType field.