Class VkPhysicalDeviceHostImageCopyProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceHostImageCopyProperties>

org.lwjgl.vulkan.VkPhysicalDeviceHostImageCopyProperties

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkPhysicalDeviceHostImageCopyPropertiesEXT

public class VkPhysicalDeviceHostImageCopyProperties
extends Struct<VkPhysicalDeviceHostImageCopyProperties>
implements NativeResource

struct VkPhysicalDeviceHostImageCopyProperties {
    VkStructureType sType;
    void * pNext;
    uint32_t copySrcLayoutCount;
    VkImageLayout * pCopySrcLayouts;
    uint32_t copyDstLayoutCount;
    VkImageLayout * pCopyDstLayouts;
    uint8_t optimalTilingLayoutUUID[VK_UUID_SIZE];
    VkBool32 identicalMemoryTypeRequirements;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceHostImageCopyProperties.Buffer	An array of VkPhysicalDeviceHostImageCopyProperties structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	COPYDSTLAYOUTCOUNT	The struct member offsets.
static final int	COPYSRCLAYOUTCOUNT	The struct member offsets.
static final int	IDENTICALMEMORYTYPEREQUIREMENTS	The struct member offsets.
static final int	OPTIMALTILINGLAYOUTUUID	The struct member offsets.
static final int	PCOPYDSTLAYOUTS	The struct member offsets.
static final int	PCOPYSRCLAYOUTS	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.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkPhysicalDeviceHostImageCopyProperties(ByteBuffer container)	Creates a VkPhysicalDeviceHostImageCopyProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceHostImageCopyProperties	calloc()	Returns a new VkPhysicalDeviceHostImageCopyProperties instance allocated with memCalloc.
static VkPhysicalDeviceHostImageCopyProperties.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceHostImageCopyProperties.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceHostImageCopyProperties.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceHostImageCopyProperties	calloc(MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	copyDstLayoutCount()
VkPhysicalDeviceHostImageCopyProperties	copyDstLayoutCount(int value)	Sets the specified value to the copyDstLayoutCount field.
int	copySrcLayoutCount()
VkPhysicalDeviceHostImageCopyProperties	copySrcLayoutCount(int value)	Sets the specified value to the copySrcLayoutCount field.
static VkPhysicalDeviceHostImageCopyProperties	create()	Returns a new VkPhysicalDeviceHostImageCopyProperties instance allocated with BufferUtils.
static VkPhysicalDeviceHostImageCopyProperties.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceHostImageCopyProperties.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceHostImageCopyProperties	create(long address)	Returns a new VkPhysicalDeviceHostImageCopyProperties instance for the specified memory address.
static VkPhysicalDeviceHostImageCopyProperties.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceHostImageCopyProperties.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceHostImageCopyProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceHostImageCopyProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	identicalMemoryTypeRequirements()
VkPhysicalDeviceHostImageCopyProperties	identicalMemoryTypeRequirements(boolean value)	Sets the specified value to the identicalMemoryTypeRequirements field.
static VkPhysicalDeviceHostImageCopyProperties	malloc()	Returns a new VkPhysicalDeviceHostImageCopyProperties instance allocated with memAlloc.
static VkPhysicalDeviceHostImageCopyProperties.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceHostImageCopyProperties.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceHostImageCopyProperties.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyProperties.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceHostImageCopyProperties	malloc(MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyProperties instance allocated on the specified MemoryStack.
static int	ncopyDstLayoutCount(long struct)	Unsafe version of copyDstLayoutCount().
static void	ncopyDstLayoutCount(long struct, int value)	Sets the specified value to the copyDstLayoutCount field of the specified struct.
static int	ncopySrcLayoutCount(long struct)	Unsafe version of copySrcLayoutCount().
static void	ncopySrcLayoutCount(long struct, int value)	Sets the specified value to the copySrcLayoutCount field of the specified struct.
static int	nidenticalMemoryTypeRequirements(long struct)	Unsafe version of identicalMemoryTypeRequirements().
static void	nidenticalMemoryTypeRequirements(long struct, int value)	Unsafe version of identicalMemoryTypeRequirements.
static ByteBuffer	noptimalTilingLayoutUUID(long struct)	Unsafe version of optimalTilingLayoutUUID().
static byte	noptimalTilingLayoutUUID(long struct, int index)	Unsafe version of optimalTilingLayoutUUID.
static void	noptimalTilingLayoutUUID(long struct, int index, byte value)	Unsafe version of optimalTilingLayoutUUID.
static void	noptimalTilingLayoutUUID(long struct, ByteBuffer value)	Unsafe version of optimalTilingLayoutUUID.
static @Nullable IntBuffer	npCopyDstLayouts(long struct)	Unsafe version of pCopyDstLayouts.
static void	npCopyDstLayouts(long struct, @Nullable IntBuffer value)	Unsafe version of pCopyDstLayouts.
static @Nullable IntBuffer	npCopySrcLayouts(long struct)	Unsafe version of pCopySrcLayouts.
static void	npCopySrcLayouts(long struct, @Nullable IntBuffer value)	Unsafe version of pCopySrcLayouts.
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.
ByteBuffer	optimalTilingLayoutUUID()
byte	optimalTilingLayoutUUID(int index)
VkPhysicalDeviceHostImageCopyProperties	optimalTilingLayoutUUID(int index, byte value)	Sets the specified value at the specified index of the optimalTilingLayoutUUID field.
VkPhysicalDeviceHostImageCopyProperties	optimalTilingLayoutUUID(ByteBuffer value)	Copies the specified ByteBuffer to the optimalTilingLayoutUUID field.
@Nullable IntBuffer	pCopyDstLayouts()
VkPhysicalDeviceHostImageCopyProperties	pCopyDstLayouts(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pCopyDstLayouts field.
@Nullable IntBuffer	pCopySrcLayouts()
VkPhysicalDeviceHostImageCopyProperties	pCopySrcLayouts(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pCopySrcLayouts field.
long	pNext()
VkPhysicalDeviceHostImageCopyProperties	pNext(long value)	Sets the specified value to the pNext field.
VkPhysicalDeviceHostImageCopyProperties	set(int sType, long pNext, int copySrcLayoutCount, @Nullable IntBuffer pCopySrcLayouts, int copyDstLayoutCount, @Nullable IntBuffer pCopyDstLayouts, ByteBuffer optimalTilingLayoutUUID, boolean identicalMemoryTypeRequirements)	Initializes this struct with the specified values.
VkPhysicalDeviceHostImageCopyProperties	set(VkPhysicalDeviceHostImageCopyProperties src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkPhysicalDeviceHostImageCopyProperties	sType(int value)	Sets the specified value to the sType field.
VkPhysicalDeviceHostImageCopyProperties	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES value to the sType field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

COPYSRCLAYOUTCOUNT

public static final int COPYSRCLAYOUTCOUNT

The struct member offsets.

PCOPYSRCLAYOUTS

public static final int PCOPYSRCLAYOUTS

The struct member offsets.

COPYDSTLAYOUTCOUNT

public static final int COPYDSTLAYOUTCOUNT

The struct member offsets.

PCOPYDSTLAYOUTS

public static final int PCOPYDSTLAYOUTS

The struct member offsets.

OPTIMALTILINGLAYOUTUUID

public static final int OPTIMALTILINGLAYOUTUUID

The struct member offsets.

IDENTICALMEMORYTYPEREQUIREMENTS

public static final int IDENTICALMEMORYTYPEREQUIREMENTS

The struct member offsets.

Constructor Details

VkPhysicalDeviceHostImageCopyProperties

public VkPhysicalDeviceHostImageCopyProperties(ByteBuffer container)

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

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void *")
public long pNext()

Returns:

the value of the pNext field.

copySrcLayoutCount

@NativeType("uint32_t")
public int copySrcLayoutCount()

Returns:

the value of the copySrcLayoutCount field.

pCopySrcLayouts

@NativeType("VkImageLayout *")
public @Nullable IntBuffer pCopySrcLayouts()

Returns:

a IntBuffer view of the data pointed to by the pCopySrcLayouts field.

copyDstLayoutCount

@NativeType("uint32_t")
public int copyDstLayoutCount()

Returns:

the value of the copyDstLayoutCount field.

pCopyDstLayouts

@NativeType("VkImageLayout *")
public @Nullable IntBuffer pCopyDstLayouts()

Returns:

a IntBuffer view of the data pointed to by the pCopyDstLayouts field.

optimalTilingLayoutUUID

@NativeType("uint8_t[VK_UUID_SIZE]")
public ByteBuffer optimalTilingLayoutUUID()

Returns:

a ByteBuffer view of the optimalTilingLayoutUUID field.

optimalTilingLayoutUUID

@NativeType("uint8_t")
public byte optimalTilingLayoutUUID(int index)

Returns:

the value at the specified index of the optimalTilingLayoutUUID field.

identicalMemoryTypeRequirements

@NativeType("VkBool32")
public boolean identicalMemoryTypeRequirements()

Returns:

the value of the identicalMemoryTypeRequirements field.

sType

public VkPhysicalDeviceHostImageCopyProperties sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkPhysicalDeviceHostImageCopyProperties sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES value to the sType field.

pNext

public VkPhysicalDeviceHostImageCopyProperties pNext(@NativeType("void *")
 long value)

Sets the specified value to the pNext field.

copySrcLayoutCount

public VkPhysicalDeviceHostImageCopyProperties copySrcLayoutCount(@NativeType("uint32_t")
 int value)

Sets the specified value to the copySrcLayoutCount field.

pCopySrcLayouts

public VkPhysicalDeviceHostImageCopyProperties pCopySrcLayouts(@NativeType("VkImageLayout *")
 @Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pCopySrcLayouts field.

copyDstLayoutCount

public VkPhysicalDeviceHostImageCopyProperties copyDstLayoutCount(@NativeType("uint32_t")
 int value)

Sets the specified value to the copyDstLayoutCount field.

pCopyDstLayouts

public VkPhysicalDeviceHostImageCopyProperties pCopyDstLayouts(@NativeType("VkImageLayout *")
 @Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pCopyDstLayouts field.

optimalTilingLayoutUUID

public VkPhysicalDeviceHostImageCopyProperties optimalTilingLayoutUUID(@NativeType("uint8_t[VK_UUID_SIZE]")
 ByteBuffer value)

Copies the specified ByteBuffer to the optimalTilingLayoutUUID field.

optimalTilingLayoutUUID

public VkPhysicalDeviceHostImageCopyProperties optimalTilingLayoutUUID(int index,
 @NativeType("uint8_t")
 byte value)

Sets the specified value at the specified index of the optimalTilingLayoutUUID field.

identicalMemoryTypeRequirements

public VkPhysicalDeviceHostImageCopyProperties identicalMemoryTypeRequirements(@NativeType("VkBool32")
 boolean value)

Sets the specified value to the identicalMemoryTypeRequirements field.

set

public VkPhysicalDeviceHostImageCopyProperties set(int sType,
 long pNext,
 int copySrcLayoutCount,
 @Nullable IntBuffer pCopySrcLayouts,
 int copyDstLayoutCount,
 @Nullable IntBuffer pCopyDstLayouts,
 ByteBuffer optimalTilingLayoutUUID,
 boolean identicalMemoryTypeRequirements)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceHostImageCopyProperties set(VkPhysicalDeviceHostImageCopyProperties src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceHostImageCopyProperties malloc()

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

calloc

public static VkPhysicalDeviceHostImageCopyProperties calloc()

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

create

public static VkPhysicalDeviceHostImageCopyProperties create()

Returns a new VkPhysicalDeviceHostImageCopyProperties instance allocated with BufferUtils.

create

public static VkPhysicalDeviceHostImageCopyProperties create(long address)

Returns a new VkPhysicalDeviceHostImageCopyProperties instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceHostImageCopyProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceHostImageCopyProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceHostImageCopyProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceHostImageCopyProperties.Buffer create(int capacity)

Returns a new VkPhysicalDeviceHostImageCopyProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceHostImageCopyProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceHostImageCopyProperties malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceHostImageCopyProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceHostImageCopyProperties calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncopySrcLayoutCount

public static int ncopySrcLayoutCount(long struct)

Unsafe version of copySrcLayoutCount().

npCopySrcLayouts

public static @Nullable IntBuffer npCopySrcLayouts(long struct)

Unsafe version of pCopySrcLayouts.

ncopyDstLayoutCount

public static int ncopyDstLayoutCount(long struct)

Unsafe version of copyDstLayoutCount().

npCopyDstLayouts

public static @Nullable IntBuffer npCopyDstLayouts(long struct)

Unsafe version of pCopyDstLayouts.

noptimalTilingLayoutUUID

public static ByteBuffer noptimalTilingLayoutUUID(long struct)

Unsafe version of optimalTilingLayoutUUID().

noptimalTilingLayoutUUID

public static byte noptimalTilingLayoutUUID(long struct,
 int index)

Unsafe version of optimalTilingLayoutUUID.

nidenticalMemoryTypeRequirements

public static int nidenticalMemoryTypeRequirements(long struct)

Unsafe version of identicalMemoryTypeRequirements().

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.

ncopySrcLayoutCount

public static void ncopySrcLayoutCount(long struct,
 int value)

Sets the specified value to the copySrcLayoutCount field of the specified struct.

npCopySrcLayouts

public static void npCopySrcLayouts(long struct,
 @Nullable IntBuffer value)

Unsafe version of pCopySrcLayouts.

ncopyDstLayoutCount

public static void ncopyDstLayoutCount(long struct,
 int value)

Sets the specified value to the copyDstLayoutCount field of the specified struct.

npCopyDstLayouts

public static void npCopyDstLayouts(long struct,
 @Nullable IntBuffer value)

Unsafe version of pCopyDstLayouts.

noptimalTilingLayoutUUID

public static void noptimalTilingLayoutUUID(long struct,
 ByteBuffer value)

Unsafe version of optimalTilingLayoutUUID.

noptimalTilingLayoutUUID

public static void noptimalTilingLayoutUUID(long struct,
 int index,
 byte value)

Unsafe version of optimalTilingLayoutUUID.

nidenticalMemoryTypeRequirements

public static void nidenticalMemoryTypeRequirements(long struct,
 int value)

Unsafe version of identicalMemoryTypeRequirements.