Package org.lwjgl.vulkan

Class VkHostImageLayoutTransitionInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkHostImageLayoutTransitionInfo>

org.lwjgl.vulkan.VkHostImageLayoutTransitionInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkHostImageLayoutTransitionInfoEXT

public class VkHostImageLayoutTransitionInfo
extends Struct<VkHostImageLayoutTransitionInfo>
implements NativeResource

 struct VkHostImageLayoutTransitionInfo {
     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	VkHostImageLayoutTransitionInfo.Buffer	An array of VkHostImageLayoutTransitionInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

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
VkHostImageLayoutTransitionInfo(ByteBuffer container)	Creates a VkHostImageLayoutTransitionInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkHostImageLayoutTransitionInfo	calloc()	Returns a new VkHostImageLayoutTransitionInfo instance allocated with memCalloc.
static VkHostImageLayoutTransitionInfo.Buffer	calloc(int capacity)	Returns a new VkHostImageLayoutTransitionInfo.Buffer instance allocated with memCalloc.
static VkHostImageLayoutTransitionInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkHostImageLayoutTransitionInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkHostImageLayoutTransitionInfo	calloc(MemoryStack stack)	Returns a new VkHostImageLayoutTransitionInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkHostImageLayoutTransitionInfo	create()	Returns a new VkHostImageLayoutTransitionInfo instance allocated with BufferUtils.
static VkHostImageLayoutTransitionInfo.Buffer	create(int capacity)	Returns a new VkHostImageLayoutTransitionInfo.Buffer instance allocated with BufferUtils.
static VkHostImageLayoutTransitionInfo	create(long address)	Returns a new VkHostImageLayoutTransitionInfo instance for the specified memory address.
static VkHostImageLayoutTransitionInfo.Buffer	create(long address, int capacity)	Create a VkHostImageLayoutTransitionInfo.Buffer instance at the specified memory.
static @Nullable VkHostImageLayoutTransitionInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkHostImageLayoutTransitionInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	image()
VkHostImageLayoutTransitionInfo	image(long value)	Sets the specified value to the image field.
static VkHostImageLayoutTransitionInfo	malloc()	Returns a new VkHostImageLayoutTransitionInfo instance allocated with memAlloc.
static VkHostImageLayoutTransitionInfo.Buffer	malloc(int capacity)	Returns a new VkHostImageLayoutTransitionInfo.Buffer instance allocated with memAlloc.
static VkHostImageLayoutTransitionInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkHostImageLayoutTransitionInfo.Buffer instance allocated on the specified MemoryStack.
static VkHostImageLayoutTransitionInfo	malloc(MemoryStack stack)	Returns a new VkHostImageLayoutTransitionInfo instance allocated on the specified MemoryStack.
int	newLayout()
VkHostImageLayoutTransitionInfo	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()
VkHostImageLayoutTransitionInfo	oldLayout(int value)	Sets the specified value to the oldLayout field.
long	pNext()
VkHostImageLayoutTransitionInfo	pNext(long value)	Sets the specified value to the pNext field.
VkHostImageLayoutTransitionInfo	set(int sType, long pNext, long image, int oldLayout, int newLayout, VkImageSubresourceRange subresourceRange)	Initializes this struct with the specified values.
VkHostImageLayoutTransitionInfo	set(VkHostImageLayoutTransitionInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkHostImageLayoutTransitionInfo	sType(int value)	Sets the specified value to the sType field.
VkHostImageLayoutTransitionInfo	sType$Default()	Sets the STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO value to the sType field.
VkImageSubresourceRange	subresourceRange()
VkHostImageLayoutTransitionInfo	subresourceRange(Consumer<VkImageSubresourceRange> consumer)	Passes the subresourceRange field to the specified Consumer.
VkHostImageLayoutTransitionInfo	subresourceRange(VkImageSubresourceRange value)	Copies the specified VkImageSubresourceRange to the subresourceRange field.

Methods inherited from class org.lwjgl.system.Struct

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

VkHostImageLayoutTransitionInfo

public VkHostImageLayoutTransitionInfo(ByteBuffer container)

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

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkHostImageLayoutTransitionInfo>

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

image

public long image()

Returns:

the value of the image field.

oldLayout

public int oldLayout()

Returns:

the value of the oldLayout field.

newLayout

public int newLayout()

Returns:

the value of the newLayout field.

subresourceRange

public VkImageSubresourceRange subresourceRange()

Returns:

a VkImageSubresourceRange view of the subresourceRange field.

sType

public VkHostImageLayoutTransitionInfo sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkHostImageLayoutTransitionInfo sType$Default()

Sets the STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO value to the sType field.

pNext

public VkHostImageLayoutTransitionInfo pNext(long value)

Sets the specified value to the pNext field.

image

public VkHostImageLayoutTransitionInfo image(long value)

Sets the specified value to the image field.

oldLayout

public VkHostImageLayoutTransitionInfo oldLayout(int value)

Sets the specified value to the oldLayout field.

newLayout

public VkHostImageLayoutTransitionInfo newLayout(int value)

Sets the specified value to the newLayout field.

subresourceRange

public VkHostImageLayoutTransitionInfo subresourceRange(VkImageSubresourceRange value)

Copies the specified VkImageSubresourceRange to the subresourceRange field.

subresourceRange

public VkHostImageLayoutTransitionInfo subresourceRange(Consumer<VkImageSubresourceRange> consumer)

Passes the subresourceRange field to the specified Consumer.

set

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

Initializes this struct with the specified values.

set

public VkHostImageLayoutTransitionInfo set(VkHostImageLayoutTransitionInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkHostImageLayoutTransitionInfo malloc()

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

calloc

public static VkHostImageLayoutTransitionInfo calloc()

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

create

public static VkHostImageLayoutTransitionInfo create()

Returns a new VkHostImageLayoutTransitionInfo instance allocated with BufferUtils.

create

public static VkHostImageLayoutTransitionInfo create(long address)

Returns a new VkHostImageLayoutTransitionInfo instance for the specified memory address.

createSafe

public static @Nullable VkHostImageLayoutTransitionInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkHostImageLayoutTransitionInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkHostImageLayoutTransitionInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkHostImageLayoutTransitionInfo.Buffer create(int capacity)

Returns a new VkHostImageLayoutTransitionInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkHostImageLayoutTransitionInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkHostImageLayoutTransitionInfo malloc(MemoryStack stack)

Returns a new VkHostImageLayoutTransitionInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkHostImageLayoutTransitionInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkHostImageLayoutTransitionInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkHostImageLayoutTransitionInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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