Package org.lwjgl.vulkan

Class VkImageToMemoryCopyEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageToMemoryCopy>

org.lwjgl.vulkan.VkImageToMemoryCopy

org.lwjgl.vulkan.VkImageToMemoryCopyEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkImageToMemoryCopyEXT
extends VkImageToMemoryCopy

 struct VkImageToMemoryCopyEXT {
     VkStructureType sType;
     void const * pNext;
     void * pHostPointer;
     uint32_t memoryRowLength;
     uint32_t memoryImageHeight;
     {@link VkImageSubresourceLayers VkImageSubresourceLayers} imageSubresource;
     {@link VkOffset3D VkOffset3D} imageOffset;
     {@link VkExtent3D VkExtent3D} imageExtent;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageToMemoryCopyEXT.Buffer	An array of VkImageToMemoryCopyEXT 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 inherited from class org.lwjgl.vulkan.VkImageToMemoryCopy

ALIGNOF, IMAGEEXTENT, IMAGEOFFSET, IMAGESUBRESOURCE, MEMORYIMAGEHEIGHT, MEMORYROWLENGTH, PHOSTPOINTER, PNEXT, SIZEOF, STYPE

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageToMemoryCopyEXT	calloc()	Returns a new VkImageToMemoryCopyEXT instance allocated with memCalloc.
static VkImageToMemoryCopyEXT.Buffer	calloc(int capacity)	Returns a new VkImageToMemoryCopyEXT.Buffer instance allocated with memCalloc.
static VkImageToMemoryCopyEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkImageToMemoryCopyEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageToMemoryCopyEXT	calloc(MemoryStack stack)	Returns a new VkImageToMemoryCopyEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageToMemoryCopyEXT	create()	Returns a new VkImageToMemoryCopyEXT instance allocated with BufferUtils.
static VkImageToMemoryCopyEXT.Buffer	create(int capacity)	Returns a new VkImageToMemoryCopyEXT.Buffer instance allocated with BufferUtils.
static VkImageToMemoryCopyEXT	create(long address)	Returns a new VkImageToMemoryCopyEXT instance for the specified memory address.
static VkImageToMemoryCopyEXT.Buffer	create(long address, int capacity)	Create a VkImageToMemoryCopyEXT.Buffer instance at the specified memory.
static @Nullable VkImageToMemoryCopyEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageToMemoryCopyEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkImageToMemoryCopyEXT	imageExtent(Consumer<VkExtent3D> consumer)	Passes the imageExtent field to the specified Consumer.
VkImageToMemoryCopyEXT	imageExtent(VkExtent3D value)	Copies the specified VkExtent3D to the imageExtent field.
VkImageToMemoryCopyEXT	imageOffset(Consumer<VkOffset3D> consumer)	Passes the imageOffset field to the specified Consumer.
VkImageToMemoryCopyEXT	imageOffset(VkOffset3D value)	Copies the specified VkOffset3D to the imageOffset field.
VkImageToMemoryCopyEXT	imageSubresource(Consumer<VkImageSubresourceLayers> consumer)	Passes the imageSubresource field to the specified Consumer.
VkImageToMemoryCopyEXT	imageSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the imageSubresource field.
static VkImageToMemoryCopyEXT	malloc()	Returns a new VkImageToMemoryCopyEXT instance allocated with memAlloc.
static VkImageToMemoryCopyEXT.Buffer	malloc(int capacity)	Returns a new VkImageToMemoryCopyEXT.Buffer instance allocated with memAlloc.
static VkImageToMemoryCopyEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkImageToMemoryCopyEXT.Buffer instance allocated on the specified MemoryStack.
static VkImageToMemoryCopyEXT	malloc(MemoryStack stack)	Returns a new VkImageToMemoryCopyEXT instance allocated on the specified MemoryStack.
VkImageToMemoryCopyEXT	memoryImageHeight(int value)	Sets the specified value to the memoryImageHeight field.
VkImageToMemoryCopyEXT	memoryRowLength(int value)	Sets the specified value to the memoryRowLength field.
VkImageToMemoryCopyEXT	pHostPointer(long value)	Sets the specified value to the pHostPointer field.
VkImageToMemoryCopyEXT	pNext(long value)	Sets the specified value to the pNext field.
VkImageToMemoryCopyEXT	set(int sType, long pNext, long pHostPointer, int memoryRowLength, int memoryImageHeight, VkImageSubresourceLayers imageSubresource, VkOffset3D imageOffset, VkExtent3D imageExtent)	Initializes this struct with the specified values.
VkImageToMemoryCopyEXT	set(VkImageToMemoryCopyEXT src)	Copies the specified struct data to this struct.
VkImageToMemoryCopyEXT	sType(int value)	Sets the specified value to the sType field.
VkImageToMemoryCopyEXT	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY value to the sType field.

Methods inherited from class org.lwjgl.vulkan.VkImageToMemoryCopy

imageExtent, imageOffset, imageSubresource, memoryImageHeight, memoryRowLength, nimageExtent, nimageExtent, nimageOffset, nimageOffset, nimageSubresource, nimageSubresource, nmemoryImageHeight, nmemoryImageHeight, nmemoryRowLength, nmemoryRowLength, npHostPointer, npHostPointer, npNext, npNext, nsType, nsType, pHostPointer, pNext, set, sizeof, sType, validate

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

Constructor Details

VkImageToMemoryCopyEXT

public VkImageToMemoryCopyEXT(ByteBuffer container)

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

sType

public VkImageToMemoryCopyEXT sType(int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkImageToMemoryCopy

sType$Default

public VkImageToMemoryCopyEXT sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY value to the sType field.

Overrides:

sType$Default in class VkImageToMemoryCopy

pNext

public VkImageToMemoryCopyEXT pNext(long value)

Sets the specified value to the pNext field.

Overrides:

pNext in class VkImageToMemoryCopy

pHostPointer

public VkImageToMemoryCopyEXT pHostPointer(long value)

Sets the specified value to the pHostPointer field.

Overrides:

pHostPointer in class VkImageToMemoryCopy

memoryRowLength

public VkImageToMemoryCopyEXT memoryRowLength(int value)

Sets the specified value to the memoryRowLength field.

Overrides:

memoryRowLength in class VkImageToMemoryCopy

memoryImageHeight

public VkImageToMemoryCopyEXT memoryImageHeight(int value)

Sets the specified value to the memoryImageHeight field.

Overrides:

memoryImageHeight in class VkImageToMemoryCopy

imageSubresource

public VkImageToMemoryCopyEXT imageSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the imageSubresource field.

Overrides:

imageSubresource in class VkImageToMemoryCopy

imageSubresource

public VkImageToMemoryCopyEXT imageSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the imageSubresource field to the specified Consumer.

Overrides:

imageSubresource in class VkImageToMemoryCopy

imageOffset

public VkImageToMemoryCopyEXT imageOffset(VkOffset3D value)

Copies the specified VkOffset3D to the imageOffset field.

Overrides:

imageOffset in class VkImageToMemoryCopy

imageOffset

public VkImageToMemoryCopyEXT imageOffset(Consumer<VkOffset3D> consumer)

Passes the imageOffset field to the specified Consumer.

Overrides:

imageOffset in class VkImageToMemoryCopy

imageExtent

public VkImageToMemoryCopyEXT imageExtent(VkExtent3D value)

Copies the specified VkExtent3D to the imageExtent field.

Overrides:

imageExtent in class VkImageToMemoryCopy

imageExtent

public VkImageToMemoryCopyEXT imageExtent(Consumer<VkExtent3D> consumer)

Passes the imageExtent field to the specified Consumer.

Overrides:

imageExtent in class VkImageToMemoryCopy

set

public VkImageToMemoryCopyEXT set(int sType,
 long pNext,
 long pHostPointer,
 int memoryRowLength,
 int memoryImageHeight,
 VkImageSubresourceLayers imageSubresource,
 VkOffset3D imageOffset,
 VkExtent3D imageExtent)

Initializes this struct with the specified values.

Overrides:

set in class VkImageToMemoryCopy

set

public VkImageToMemoryCopyEXT set(VkImageToMemoryCopyEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageToMemoryCopyEXT malloc()

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

calloc

public static VkImageToMemoryCopyEXT calloc()

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

create

public static VkImageToMemoryCopyEXT create()

Returns a new VkImageToMemoryCopyEXT instance allocated with BufferUtils.

create

public static VkImageToMemoryCopyEXT create(long address)

Returns a new VkImageToMemoryCopyEXT instance for the specified memory address.

createSafe

public static @Nullable VkImageToMemoryCopyEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageToMemoryCopyEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageToMemoryCopyEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageToMemoryCopyEXT.Buffer create(int capacity)

Returns a new VkImageToMemoryCopyEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageToMemoryCopyEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkImageToMemoryCopyEXT malloc(MemoryStack stack)

Returns a new VkImageToMemoryCopyEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageToMemoryCopyEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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