Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSubresourceHostMemcpySizeEXT

extends Struct<VkSubresourceHostMemcpySizeEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Memory size needed to copy to or from an image on the host with VK_HOST_IMAGE_COPY_MEMCPY_EXT.
Valid Usage (Implicit)

Layout


struct VkSubresourceHostMemcpySizeEXT {
    VkStructureType sType;
    void * pNext;
    VkDeviceSize size;
}

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
PNEXT

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkSubresourceHostMemcpySizeEXT(long address, ByteBuffer container)

public
VkSubresourceHostMemcpySizeEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSubresourceHostMemcpySizeEXT
calloc()

Returns a new VkSubresourceHostMemcpySizeEXT instance allocated with memCalloc.

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

Returns a new VkSubresourceHostMemcpySizeEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkSubresourceHostMemcpySizeEXT instance allocated with BufferUtils.

public static VkSubresourceHostMemcpySizeEXT
create(long address)

Returns a new VkSubresourceHostMemcpySizeEXT instance for the specified memory address.

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

Returns a new VkSubresourceHostMemcpySizeEXT.Buffer instance allocated with BufferUtils.

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

Create a VkSubresourceHostMemcpySizeEXT.Buffer instance at the specified memory.

public static VkSubresourceHostMemcpySizeEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSubresourceHostMemcpySizeEXT
malloc()

Returns a new VkSubresourceHostMemcpySizeEXT instance allocated with memAlloc.

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

Returns a new VkSubresourceHostMemcpySizeEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkSubresourceHostMemcpySizeEXT instance allocated on the specified MemoryStack.

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

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static long
nsize(long struct)

Unsafe version of size.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSubresourceHostMemcpySizeEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkSubresourceHostMemcpySizeEXT
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkSubresourceHostMemcpySizeEXT

Returns:

this struct
set
(VkSubresourceHostMemcpySizeEXT
the source struct
src
)

Copies the specified struct data to this struct.

public long
size()

the size in bytes of the image subresource.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkSubresourceHostMemcpySizeEXT
sType(int value)

Sets the specified value to the sType field.

public VkSubresourceHostMemcpySizeEXT
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.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEback to summary
public static final int SIZE

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.

Constructor Detail

VkSubresourceHostMemcpySizeEXTback to summary
protected VkSubresourceHostMemcpySizeEXT(long address, ByteBuffer container)
VkSubresourceHostMemcpySizeEXTback to summary
public VkSubresourceHostMemcpySizeEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSubresourceHostMemcpySizeEXT calloc(MemoryStack stack)

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

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

Returns a new VkSubresourceHostMemcpySizeEXT instance allocated with BufferUtils.

createback to summary
public static VkSubresourceHostMemcpySizeEXT create(long address)

Returns a new VkSubresourceHostMemcpySizeEXT instance for the specified memory address.

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

Returns a new VkSubresourceHostMemcpySizeEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSubresourceHostMemcpySizeEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSubresourceHostMemcpySizeEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkSubresourceHostMemcpySizeEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSubresourceHostMemcpySizeEXT malloc(MemoryStack stack)

Returns a new VkSubresourceHostMemcpySizeEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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.

nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkSubresourceHostMemcpySizeEXT set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkSubresourceHostMemcpySizeEXT set(VkSubresourceHostMemcpySizeEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkSubresourceHostMemcpySizeEXT

the source struct

Returns:VkSubresourceHostMemcpySizeEXT

this struct

sizeback to summary
public long size()

the size in bytes of the image subresource.

Annotations
@NativeType:VkDeviceSize
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 VkSubresourceHostMemcpySizeEXT sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkSubresourceHostMemcpySizeEXT.Buffer

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

An array of VkSubresourceHostMemcpySizeEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkSubresourceHostMemcpySizeEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public VkSubresourceHostMemcpySizeEXT.Buffer
pNext(long value)

Sets the specified value to the VkSubresourceHostMemcpySizeEXT#pNext field.

protected VkSubresourceHostMemcpySizeEXT.Buffer
public long

Returns:

the value of the VkSubresourceHostMemcpySizeEXT#size field.
size
()

public int

Returns:

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

public VkSubresourceHostMemcpySizeEXT.Buffer
sType(int value)

Sets the specified value to the VkSubresourceHostMemcpySizeEXT#sType field.

public VkSubresourceHostMemcpySizeEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSubresourceHostMemcpySizeEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSubresourceHostMemcpySizeEXT.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 VkSubresourceHostMemcpySizeEXT#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 VkSubresourceHostMemcpySizeEXT getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkSubresourceHostMemcpySizeEXT#pNext field.

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

Sets the specified value to the VkSubresourceHostMemcpySizeEXT#pNext field.

selfback to summary
protected VkSubresourceHostMemcpySizeEXT.Buffer self()

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

Annotations
@Override
sizeback to summary
public long size()
Returns:long

the value of the VkSubresourceHostMemcpySizeEXT#size field.

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

the value of the VkSubresourceHostMemcpySizeEXT#sType field.

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

Sets the specified value to the VkSubresourceHostMemcpySizeEXT#sType field.

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

Sets the STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT value to the VkSubresourceHostMemcpySizeEXT#sType field.