Package org.lwjgl.vulkan

Class VkSubresourceHostMemcpySize

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSubresourceHostMemcpySize>

org.lwjgl.vulkan.VkSubresourceHostMemcpySize

All Implemented Interfaces:

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

Direct Known Subclasses:

VkSubresourceHostMemcpySizeEXT

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

Memory size needed to copy to or from an image on the host with VK_HOST_IMAGE_COPY_MEMCPY.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE

Layout

 struct VkSubresourceHostMemcpySize {
     VkStructureType sType();
     void * pNext();
     VkDeviceSize size();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSubresourceHostMemcpySize.Buffer	An array of VkSubresourceHostMemcpySize 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	PNEXT	The struct member offsets.
static final int	SIZE	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 org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSubresourceHostMemcpySize	calloc()	Returns a new VkSubresourceHostMemcpySize instance allocated with memCalloc.
static VkSubresourceHostMemcpySize.Buffer	calloc(int capacity)	Returns a new VkSubresourceHostMemcpySize.Buffer instance allocated with memCalloc.
static VkSubresourceHostMemcpySize.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSubresourceHostMemcpySize.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSubresourceHostMemcpySize	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSubresourceHostMemcpySize instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSubresourceHostMemcpySize	create()	Returns a new VkSubresourceHostMemcpySize instance allocated with BufferUtils.
static VkSubresourceHostMemcpySize.Buffer	create(int capacity)	Returns a new VkSubresourceHostMemcpySize.Buffer instance allocated with BufferUtils.
static VkSubresourceHostMemcpySize	create(long address)	Returns a new VkSubresourceHostMemcpySize instance for the specified memory address.
static VkSubresourceHostMemcpySize.Buffer	create(long address, int capacity)	Create a VkSubresourceHostMemcpySize.Buffer instance at the specified memory.
static @Nullable VkSubresourceHostMemcpySize	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSubresourceHostMemcpySize.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSubresourceHostMemcpySize	malloc()	Returns a new VkSubresourceHostMemcpySize instance allocated with memAlloc.
static VkSubresourceHostMemcpySize.Buffer	malloc(int capacity)	Returns a new VkSubresourceHostMemcpySize.Buffer instance allocated with memAlloc.
static VkSubresourceHostMemcpySize.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSubresourceHostMemcpySize.Buffer instance allocated on the specified MemoryStack.
static VkSubresourceHostMemcpySize	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSubresourceHostMemcpySize instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static long	nsize(long struct)	Unsafe version of size().
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkSubresourceHostMemcpySize	pNext(long value)	Sets the specified value to the pNext() field.
VkSubresourceHostMemcpySize	set(int sType, long pNext)	Initializes this struct with the specified values.
VkSubresourceHostMemcpySize	set(VkSubresourceHostMemcpySize src)	Copies the specified struct data to this struct.
long	size()	the size in bytes of the image subresource.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkSubresourceHostMemcpySize	sType(int value)	Sets the specified value to the sType() field.
VkSubresourceHostMemcpySize	sType$Default()	Sets the STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE value to the sType() 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.

SIZE

public static final int SIZE

The struct member offsets.

Constructor Details

VkSubresourceHostMemcpySize

public VkSubresourceHostMemcpySize(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

size

public long size()

the size in bytes of the image subresource.

sType

public VkSubresourceHostMemcpySize sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSubresourceHostMemcpySize sType$Default()

Sets the STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE value to the sType() field.

pNext

public VkSubresourceHostMemcpySize pNext(long value)

Sets the specified value to the pNext() field.

set

public VkSubresourceHostMemcpySize set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkSubresourceHostMemcpySize set(VkSubresourceHostMemcpySize src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSubresourceHostMemcpySize malloc()

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

calloc

public static VkSubresourceHostMemcpySize calloc()

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

create

public static VkSubresourceHostMemcpySize create()

Returns a new VkSubresourceHostMemcpySize instance allocated with BufferUtils.

create

public static VkSubresourceHostMemcpySize create(long address)

Returns a new VkSubresourceHostMemcpySize instance for the specified memory address.

createSafe

public static @Nullable VkSubresourceHostMemcpySize createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSubresourceHostMemcpySize.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSubresourceHostMemcpySize.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSubresourceHostMemcpySize.Buffer create(int capacity)

Returns a new VkSubresourceHostMemcpySize.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSubresourceHostMemcpySize.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkSubresourceHostMemcpySize instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsize

public static long nsize(long struct)

Unsafe version of size().

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.