Package org.lwjgl.vulkan

Class VkHostImageLayoutTransitionInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkHostImageLayoutTransitionInfoEXT>

org.lwjgl.vulkan.VkHostImageLayoutTransitionInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

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

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

• image must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT

• subresourceRange.baseMipLevel must be less than the mipLevels specified in VkImageCreateInfo when image was created
• If subresourceRange.levelCount is not REMAINING_MIP_LEVELS, subresourceRange.baseMipLevel + subresourceRange.levelCount must be less than or equal to the mipLevels specified in VkImageCreateInfo when image was created
• subresourceRange.baseArrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when image was created
• If subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, subresourceRange.baseArrayLayer + subresourceRange.layerCount must be less than or equal to the arrayLayers specified in VkImageCreateInfo when image was created
• If image is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object
• If image has a color format that is single-plane, then the aspectMask member of subresourceRange must be IMAGE_ASPECT_COLOR_BIT
• If image has a color format and is not disjoint, then the aspectMask member of subresourceRange must be IMAGE_ASPECT_COLOR_BIT
• If image has a multi-planar format and the image is disjoint, then the aspectMask member of subresourceRange must include at least one multi-planar aspect mask bit or IMAGE_ASPECT_COLOR_BIT
• If image has a depth/stencil format with both depth and stencil and the separateDepthStencilLayouts feature is enabled, then the aspectMask member of subresourceRange must include either or both IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
• If image has a depth/stencil format with both depth and stencil and the separateDepthStencilLayouts feature is not enabled, then the aspectMask member of subresourceRange must include both IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
• If the aspectMask member of subresourceRange includes IMAGE_ASPECT_DEPTH_BIT, oldLayout and newLayout must not be one of IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If the aspectMask member of subresourceRange includes IMAGE_ASPECT_STENCIL_BIT, oldLayout and newLayout must not be one of IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL
• oldLayout must be either IMAGE_LAYOUT_UNDEFINED or the current layout of the image subresources as specified in subresourceRange
• If oldLayout is not IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZED, it must be one of the layouts in VkPhysicalDeviceHostImageCopyPropertiesEXT::pCopySrcLayouts
• newLayout must be one of the layouts in VkPhysicalDeviceHostImageCopyPropertiesEXT::pCopyDstLayouts

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT
• pNext must be NULL
• image must be a valid VkImage handle
• oldLayout must be a valid VkImageLayout value
• newLayout must be a valid VkImageLayout value
• subresourceRange must be a valid VkImageSubresourceRange structure

See Also

VkImageSubresourceRange, TransitionImageLayoutEXT

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkHostImageLayoutTransitionInfoEXT.Buffer	An array of VkHostImageLayoutTransitionInfoEXT 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	IMAGE	The struct member offsets.
static final int	NEWLAYOUT	The struct member offsets.
static final int	OLDLAYOUT	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	SUBRESOURCERANGE	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
VkHostImageLayoutTransitionInfoEXT(ByteBuffer container)	Creates a VkHostImageLayoutTransitionInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkHostImageLayoutTransitionInfoEXT	calloc()	Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated with memCalloc.
static VkHostImageLayoutTransitionInfoEXT.Buffer	calloc(int capacity)	Returns a new VkHostImageLayoutTransitionInfoEXT.Buffer instance allocated with memCalloc.
static VkHostImageLayoutTransitionInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkHostImageLayoutTransitionInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkHostImageLayoutTransitionInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkHostImageLayoutTransitionInfoEXT	create()	Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated with BufferUtils.
static VkHostImageLayoutTransitionInfoEXT.Buffer	create(int capacity)	Returns a new VkHostImageLayoutTransitionInfoEXT.Buffer instance allocated with BufferUtils.
static VkHostImageLayoutTransitionInfoEXT	create(long address)	Returns a new VkHostImageLayoutTransitionInfoEXT instance for the specified memory address.
static VkHostImageLayoutTransitionInfoEXT.Buffer	create(long address, int capacity)	Create a VkHostImageLayoutTransitionInfoEXT.Buffer instance at the specified memory.
static VkHostImageLayoutTransitionInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkHostImageLayoutTransitionInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	image()	a handle to the image affected by this layout transition.
VkHostImageLayoutTransitionInfoEXT	image(long value)	Sets the specified value to the image() field.
static VkHostImageLayoutTransitionInfoEXT	malloc()	Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated with memAlloc.
static VkHostImageLayoutTransitionInfoEXT.Buffer	malloc(int capacity)	Returns a new VkHostImageLayoutTransitionInfoEXT.Buffer instance allocated with memAlloc.
static VkHostImageLayoutTransitionInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkHostImageLayoutTransitionInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkHostImageLayoutTransitionInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated on the specified MemoryStack.
int	newLayout()	the new layout in an image layout transition.
VkHostImageLayoutTransitionInfoEXT	newLayout(int value)	Sets the specified value to the newLayout() field.
static long	nimage(long struct)	Unsafe version of image().
static void	nimage(long struct, long value)	Unsafe version of image.
static int	nnewLayout(long struct)	Unsafe version of newLayout().
static void	nnewLayout(long struct, int value)	Unsafe version of newLayout.
static int	noldLayout(long struct)	Unsafe version of oldLayout().
static void	noldLayout(long struct, int value)	Unsafe version of oldLayout.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static VkImageSubresourceRange	nsubresourceRange(long struct)	Unsafe version of subresourceRange().
static void	nsubresourceRange(long struct, VkImageSubresourceRange value)	Unsafe version of subresourceRange.
int	oldLayout()	the old layout in an image layout transition.
VkHostImageLayoutTransitionInfoEXT	oldLayout(int value)	Sets the specified value to the oldLayout() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkHostImageLayoutTransitionInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkHostImageLayoutTransitionInfoEXT	set(int sType, long pNext, long image, int oldLayout, int newLayout, VkImageSubresourceRange subresourceRange)	Initializes this struct with the specified values.
VkHostImageLayoutTransitionInfoEXT	set(VkHostImageLayoutTransitionInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkHostImageLayoutTransitionInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkHostImageLayoutTransitionInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT value to the sType() field.
VkImageSubresourceRange	subresourceRange()	describes the image subresource range within image that is affected by this layout transition.
VkHostImageLayoutTransitionInfoEXT	subresourceRange(Consumer<VkImageSubresourceRange> consumer)	Passes the subresourceRange() field to the specified Consumer.
VkHostImageLayoutTransitionInfoEXT	subresourceRange(VkImageSubresourceRange value)	Copies the specified VkImageSubresourceRange to the subresourceRange() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

IMAGE

public static final int IMAGE

The struct member offsets.

OLDLAYOUT

public static final int OLDLAYOUT

The struct member offsets.

NEWLAYOUT

public static final int NEWLAYOUT

The struct member offsets.

SUBRESOURCERANGE

public static final int SUBRESOURCERANGE

The struct member offsets.

Constructor Details

VkHostImageLayoutTransitionInfoEXT

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkHostImageLayoutTransitionInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

image

public long image()

a handle to the image affected by this layout transition.

oldLayout

public int oldLayout()

the old layout in an image layout transition.

newLayout

public int newLayout()

the new layout in an image layout transition.

subresourceRange

public VkImageSubresourceRange subresourceRange()

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

sType

public VkHostImageLayoutTransitionInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkHostImageLayoutTransitionInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT value to the sType() field.

pNext

public VkHostImageLayoutTransitionInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

image

public VkHostImageLayoutTransitionInfoEXT image(long value)

Sets the specified value to the image() field.

oldLayout

public VkHostImageLayoutTransitionInfoEXT oldLayout(int value)

Sets the specified value to the oldLayout() field.

newLayout

public VkHostImageLayoutTransitionInfoEXT newLayout(int value)

Sets the specified value to the newLayout() field.

subresourceRange

public VkHostImageLayoutTransitionInfoEXT subresourceRange(VkImageSubresourceRange value)

Copies the specified VkImageSubresourceRange to the subresourceRange() field.

subresourceRange

public VkHostImageLayoutTransitionInfoEXT subresourceRange(Consumer<VkImageSubresourceRange> consumer)

Passes the subresourceRange() field to the specified Consumer.

set

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

Initializes this struct with the specified values.

set

public VkHostImageLayoutTransitionInfoEXT set(VkHostImageLayoutTransitionInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkHostImageLayoutTransitionInfoEXT malloc()

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

calloc

public static VkHostImageLayoutTransitionInfoEXT calloc()

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

create

public static VkHostImageLayoutTransitionInfoEXT create()

Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated with BufferUtils.

create

public static VkHostImageLayoutTransitionInfoEXT create(long address)

Returns a new VkHostImageLayoutTransitionInfoEXT instance for the specified memory address.

createSafe

@Nullable
public static VkHostImageLayoutTransitionInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkHostImageLayoutTransitionInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkHostImageLayoutTransitionInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkHostImageLayoutTransitionInfoEXT.Buffer create(int capacity)

Returns a new VkHostImageLayoutTransitionInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkHostImageLayoutTransitionInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkHostImageLayoutTransitionInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkHostImageLayoutTransitionInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkHostImageLayoutTransitionInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkHostImageLayoutTransitionInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkHostImageLayoutTransitionInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nimage

public static long nimage(long struct)

Unsafe version of image().

noldLayout

public static int noldLayout(long struct)

Unsafe version of oldLayout().

nnewLayout

public static int nnewLayout(long struct)

Unsafe version of newLayout().

nsubresourceRange

public static VkImageSubresourceRange nsubresourceRange(long struct)

Unsafe version of subresourceRange().

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.

nimage

public static void nimage(long struct,
 long value)

Unsafe version of image.

noldLayout

public static void noldLayout(long struct,
 int value)

Unsafe version of oldLayout.

nnewLayout

public static void nnewLayout(long struct,
 int value)

Unsafe version of newLayout.

nsubresourceRange

public static void nsubresourceRange(long struct,
 VkImageSubresourceRange value)

Unsafe version of subresourceRange.