Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkHostImageLayoutTransitionInfoEXT

extends Struct<VkHostImageLayoutTransitionInfoEXT>
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 the parameters of a host-side image layout transition.
Description

vkTransitionImageLayoutEXT does not check whether the device memory associated with an image is currently in use before performing the layout transition. The application must guarantee that any previously submitted command that reads from or writes to this subresource has completed before the host performs the layout transition.

Note

Image layout transitions performed on the host do not require queue family ownership transfers as the physical layout of the image will not vary between queue families for the layouts supported by this function.

Valid Usage
Valid Usage (Implicit)
See Also

VkImageSubresourceRange, TransitionImageLayoutEXT

Layout


struct VkHostImageLayoutTransitionInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkImage image;
    VkImageLayout oldLayout;
    VkImageLayout newLayout;
    VkImageSubresourceRange subresourceRange;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
IMAGE

The struct member offsets.

public static final int
NEWLAYOUT

The struct member offsets.

public static final int
OLDLAYOUT

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
STYPE

The struct member offsets.

public static final int
SUBRESOURCERANGE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkHostImageLayoutTransitionInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkHostImageLayoutTransitionInfoEXT
calloc()

Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated with memCalloc.

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

Returns a new VkHostImageLayoutTransitionInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkHostImageLayoutTransitionInfoEXT
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 VkHostImageLayoutTransitionInfoEXT
create()

Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated with BufferUtils.

public static VkHostImageLayoutTransitionInfoEXT
create(long address)

Returns a new VkHostImageLayoutTransitionInfoEXT instance for the specified memory address.

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

Returns a new VkHostImageLayoutTransitionInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkHostImageLayoutTransitionInfoEXT.Buffer instance at the specified memory.

public static VkHostImageLayoutTransitionInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
image()

a handle to the image affected by this layout transition.

public VkHostImageLayoutTransitionInfoEXT
image(long value)

Sets the specified value to the image field.

public static VkHostImageLayoutTransitionInfoEXT
malloc()

Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated with memAlloc.

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

Returns a new VkHostImageLayoutTransitionInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated on the specified MemoryStack.

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

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

public int
newLayout()

the new layout in an image layout transition.

public VkHostImageLayoutTransitionInfoEXT
newLayout(int value)

Sets the specified value to the newLayout field.

public static long
nimage(long struct)

Unsafe version of image.

public static void
nimage(long struct, long value)

Unsafe version of image.

public static int
nnewLayout(long struct)

Unsafe version of newLayout.

public static void
nnewLayout(long struct, int value)

Unsafe version of newLayout.

public static int
noldLayout(long struct)

Unsafe version of oldLayout.

public static void
noldLayout(long struct, int value)

Unsafe version of oldLayout.

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
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static VkImageSubresourceRange
nsubresourceRange(long struct)

Unsafe version of subresourceRange.

public static void
nsubresourceRange(long struct, VkImageSubresourceRange value)

Unsafe version of subresourceRange.

public int
oldLayout()

the old layout in an image layout transition.

public VkHostImageLayoutTransitionInfoEXT
oldLayout(int value)

Sets the specified value to the oldLayout field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkHostImageLayoutTransitionInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkHostImageLayoutTransitionInfoEXT
set(int sType, long pNext, long image, int oldLayout, int newLayout, VkImageSubresourceRange subresourceRange)

Initializes this struct with the specified values.

public VkHostImageLayoutTransitionInfoEXT

Returns:

this struct
set
(VkHostImageLayoutTransitionInfoEXT
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
sType()

a VkStructureType value identifying this structure.

public VkHostImageLayoutTransitionInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkHostImageLayoutTransitionInfoEXT
public VkImageSubresourceRange
subresourceRange()

describes the image subresource range within image that is affected by this layout transition.

public VkHostImageLayoutTransitionInfoEXT
public VkHostImageLayoutTransitionInfoEXT
subresourceRange(Consumer<VkImageSubresourceRange> consumer)

Passes the subresourceRange field to the specified Consumer.

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.

IMAGEback to summary
public static final int IMAGE

The struct member offsets.

NEWLAYOUTback to summary
public static final int NEWLAYOUT

The struct member offsets.

OLDLAYOUTback to summary
public static final int OLDLAYOUT

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.

STYPEback to summary
public static final int STYPE

The struct member offsets.

SUBRESOURCERANGEback to summary
public static final int SUBRESOURCERANGE

The struct member offsets.

Constructor Detail

VkHostImageLayoutTransitionInfoEXTback to summary
protected VkHostImageLayoutTransitionInfoEXT(long address, ByteBuffer container)
VkHostImageLayoutTransitionInfoEXTback to summary
public VkHostImageLayoutTransitionInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkHostImageLayoutTransitionInfoEXT calloc(MemoryStack stack)

Returns a new VkHostImageLayoutTransitionInfoEXT 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 VkHostImageLayoutTransitionInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

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

createback to summary
protected VkHostImageLayoutTransitionInfoEXT 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 VkHostImageLayoutTransitionInfoEXT create()

Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkHostImageLayoutTransitionInfoEXT create(long address)

Returns a new VkHostImageLayoutTransitionInfoEXT instance for the specified memory address.

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

Returns a new VkHostImageLayoutTransitionInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkHostImageLayoutTransitionInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkHostImageLayoutTransitionInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
imageback to summary
public long image()

a handle to the image affected by this layout transition.

Annotations
@NativeType:VkImage
imageback to summary
public VkHostImageLayoutTransitionInfoEXT image(long value)

Sets the specified value to the image field.

mallocback to summary
public static VkHostImageLayoutTransitionInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkHostImageLayoutTransitionInfoEXT malloc(MemoryStack stack)

Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

newLayoutback to summary
public int newLayout()

the new layout in an image layout transition.

Annotations
@NativeType:VkImageLayout
newLayoutback to summary
public VkHostImageLayoutTransitionInfoEXT newLayout(int value)

Sets the specified value to the newLayout field.

nimageback to summary
public static long nimage(long struct)

Unsafe version of image.

nimageback to summary
public static void nimage(long struct, long value)

Unsafe version of image.

nnewLayoutback to summary
public static int nnewLayout(long struct)

Unsafe version of newLayout.

nnewLayoutback to summary
public static void nnewLayout(long struct, int value)

Unsafe version of newLayout.

noldLayoutback to summary
public static int noldLayout(long struct)

Unsafe version of oldLayout.

noldLayoutback to summary
public static void noldLayout(long struct, int value)

Unsafe version of oldLayout.

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.

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.

nsubresourceRangeback to summary
public static VkImageSubresourceRange nsubresourceRange(long struct)

Unsafe version of subresourceRange.

nsubresourceRangeback to summary
public static void nsubresourceRange(long struct, VkImageSubresourceRange value)

Unsafe version of subresourceRange.

oldLayoutback to summary
public int oldLayout()

the old layout in an image layout transition.

Annotations
@NativeType:VkImageLayout
oldLayoutback to summary
public VkHostImageLayoutTransitionInfoEXT oldLayout(int value)

Sets the specified value to the oldLayout field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkHostImageLayoutTransitionInfoEXT set(int sType, long pNext, long image, int oldLayout, int newLayout, VkImageSubresourceRange subresourceRange)

Initializes this struct with the specified values.

setback to summary
public VkHostImageLayoutTransitionInfoEXT set(VkHostImageLayoutTransitionInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkHostImageLayoutTransitionInfoEXT

the source struct

Returns:VkHostImageLayoutTransitionInfoEXT

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
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT value to the sType field.

subresourceRangeback to summary
public VkImageSubresourceRange subresourceRange()

describes the image subresource range within image that is affected by this layout transition.

subresourceRangeback to summary
public VkHostImageLayoutTransitionInfoEXT subresourceRange(VkImageSubresourceRange value)

Copies the specified VkImageSubresourceRange to the subresourceRange field.

subresourceRangeback to summary
public VkHostImageLayoutTransitionInfoEXT subresourceRange(Consumer<VkImageSubresourceRange> consumer)

Passes the subresourceRange field to the specified Consumer.

org.lwjgl.vulkan back to summary

public Class VkHostImageLayoutTransitionInfoEXT.Buffer

extends StructBuffer<VkHostImageLayoutTransitionInfoEXT, VkHostImageLayoutTransitionInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkHostImageLayoutTransitionInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkHostImageLayoutTransitionInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkHostImageLayoutTransitionInfoEXT.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
protected VkHostImageLayoutTransitionInfoEXT
public long

Returns:

the value of the VkHostImageLayoutTransitionInfoEXT#image field.
image
()

public VkHostImageLayoutTransitionInfoEXT.Buffer
image(long value)

Sets the specified value to the VkHostImageLayoutTransitionInfoEXT#image field.

public int

Returns:

the value of the VkHostImageLayoutTransitionInfoEXT#newLayout field.
newLayout
()

public VkHostImageLayoutTransitionInfoEXT.Buffer
newLayout(int value)

Sets the specified value to the VkHostImageLayoutTransitionInfoEXT#newLayout field.

public int

Returns:

the value of the VkHostImageLayoutTransitionInfoEXT#oldLayout field.
oldLayout
()

public VkHostImageLayoutTransitionInfoEXT.Buffer
oldLayout(int value)

Sets the specified value to the VkHostImageLayoutTransitionInfoEXT#oldLayout field.

public long

Returns:

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

public VkHostImageLayoutTransitionInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkHostImageLayoutTransitionInfoEXT#pNext field.

protected VkHostImageLayoutTransitionInfoEXT.Buffer
public int

Returns:

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

public VkHostImageLayoutTransitionInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkHostImageLayoutTransitionInfoEXT#sType field.

public VkHostImageLayoutTransitionInfoEXT.Buffer
public VkImageSubresourceRange
public VkHostImageLayoutTransitionInfoEXT.Buffer
public VkHostImageLayoutTransitionInfoEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkHostImageLayoutTransitionInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkHostImageLayoutTransitionInfoEXT.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 VkHostImageLayoutTransitionInfoEXT#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

getElementFactoryback to summary
protected VkHostImageLayoutTransitionInfoEXT getElementFactory()

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

Annotations
@Override
imageback to summary
public long image()
Returns:long

the value of the VkHostImageLayoutTransitionInfoEXT#image field.

Annotations
@NativeType:VkImage
imageback to summary
public VkHostImageLayoutTransitionInfoEXT.Buffer image(long value)

Sets the specified value to the VkHostImageLayoutTransitionInfoEXT#image field.

newLayoutback to summary
public int newLayout()
Returns:int

the value of the VkHostImageLayoutTransitionInfoEXT#newLayout field.

Annotations
@NativeType:VkImageLayout
newLayoutback to summary
public VkHostImageLayoutTransitionInfoEXT.Buffer newLayout(int value)

Sets the specified value to the VkHostImageLayoutTransitionInfoEXT#newLayout field.

oldLayoutback to summary
public int oldLayout()
Returns:int

the value of the VkHostImageLayoutTransitionInfoEXT#oldLayout field.

Annotations
@NativeType:VkImageLayout
oldLayoutback to summary
public VkHostImageLayoutTransitionInfoEXT.Buffer oldLayout(int value)

Sets the specified value to the VkHostImageLayoutTransitionInfoEXT#oldLayout field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkHostImageLayoutTransitionInfoEXT#pNext field.

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

Sets the specified value to the VkHostImageLayoutTransitionInfoEXT#pNext field.

selfback to summary
protected VkHostImageLayoutTransitionInfoEXT.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkHostImageLayoutTransitionInfoEXT#sType field.

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

Sets the specified value to the VkHostImageLayoutTransitionInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT value to the VkHostImageLayoutTransitionInfoEXT#sType field.

subresourceRangeback to summary
public VkImageSubresourceRange subresourceRange()
Returns:VkImageSubresourceRange

a VkImageSubresourceRange view of the VkHostImageLayoutTransitionInfoEXT#subresourceRange field.

subresourceRangeback to summary
public VkHostImageLayoutTransitionInfoEXT.Buffer subresourceRange(VkImageSubresourceRange value)

Copies the specified VkImageSubresourceRange to the VkHostImageLayoutTransitionInfoEXT#subresourceRange field.

subresourceRangeback to summary
public VkHostImageLayoutTransitionInfoEXT.Buffer subresourceRange(Consumer<VkImageSubresourceRange> consumer)

Passes the VkHostImageLayoutTransitionInfoEXT#subresourceRange field to the specified Consumer.