Class VkBufferImageCopy2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBufferImageCopy2>

org.lwjgl.vulkan.VkBufferImageCopy2

org.lwjgl.vulkan.VkBufferImageCopy2KHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkBufferImageCopy2KHR
extends VkBufferImageCopy2

struct VkBufferImageCopy2KHR {
    VkStructureType sType;
    void const * pNext;
    VkDeviceSize bufferOffset;
    uint32_t bufferRowLength;
    uint32_t bufferImageHeight;
    VkImageSubresourceLayers imageSubresource;
    VkOffset3D imageOffset;
    VkExtent3D imageExtent;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields inherited from class VkBufferImageCopy2

ALIGNOF, BUFFERIMAGEHEIGHT, BUFFEROFFSET, BUFFERROWLENGTH, IMAGEEXTENT, IMAGEOFFSET, IMAGESUBRESOURCE, PNEXT, SIZEOF, STYPE

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class VkBufferImageCopy2

bufferImageHeight, bufferOffset, bufferRowLength, imageExtent, imageOffset, imageSubresource, nbufferImageHeight, nbufferImageHeight, nbufferOffset, nbufferOffset, nbufferRowLength, nbufferRowLength, nimageExtent, nimageExtent, nimageOffset, nimageOffset, nimageSubresource, nimageSubresource, npNext, npNext, nsType, nsType, pNext, pNext, set, sizeof, sType

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

Constructor Details

VkBufferImageCopy2KHR

public VkBufferImageCopy2KHR(ByteBuffer container)

Creates a VkBufferImageCopy2KHR 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 VkBufferImageCopy2KHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkBufferImageCopy2

sType$Default

public VkBufferImageCopy2KHR sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_IMAGE_COPY_2 value to the sType field.

Overrides:

sType$Default in class VkBufferImageCopy2

pNext

public VkBufferImageCopy2KHR pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

Overrides:

pNext in class VkBufferImageCopy2

bufferOffset

public VkBufferImageCopy2KHR bufferOffset(@NativeType("VkDeviceSize")
 long value)

Sets the specified value to the bufferOffset field.

Overrides:

bufferOffset in class VkBufferImageCopy2

bufferRowLength

public VkBufferImageCopy2KHR bufferRowLength(@NativeType("uint32_t")
 int value)

Sets the specified value to the bufferRowLength field.

Overrides:

bufferRowLength in class VkBufferImageCopy2

bufferImageHeight

public VkBufferImageCopy2KHR bufferImageHeight(@NativeType("uint32_t")
 int value)

Sets the specified value to the bufferImageHeight field.

Overrides:

bufferImageHeight in class VkBufferImageCopy2

imageSubresource

public VkBufferImageCopy2KHR imageSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the imageSubresource field.

Overrides:

imageSubresource in class VkBufferImageCopy2

imageSubresource

public VkBufferImageCopy2KHR imageSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the imageSubresource field to the specified Consumer.

Overrides:

imageSubresource in class VkBufferImageCopy2

imageOffset

public VkBufferImageCopy2KHR imageOffset(VkOffset3D value)

Copies the specified VkOffset3D to the imageOffset field.

Overrides:

imageOffset in class VkBufferImageCopy2

imageOffset

public VkBufferImageCopy2KHR imageOffset(Consumer<VkOffset3D> consumer)

Passes the imageOffset field to the specified Consumer.

Overrides:

imageOffset in class VkBufferImageCopy2

imageExtent

public VkBufferImageCopy2KHR imageExtent(VkExtent3D value)

Copies the specified VkExtent3D to the imageExtent field.

Overrides:

imageExtent in class VkBufferImageCopy2

imageExtent

public VkBufferImageCopy2KHR imageExtent(Consumer<VkExtent3D> consumer)

Passes the imageExtent field to the specified Consumer.

Overrides:

imageExtent in class VkBufferImageCopy2

set

public VkBufferImageCopy2KHR set(int sType,
 long pNext,
 long bufferOffset,
 int bufferRowLength,
 int bufferImageHeight,
 VkImageSubresourceLayers imageSubresource,
 VkOffset3D imageOffset,
 VkExtent3D imageExtent)

Initializes this struct with the specified values.

Overrides:

set in class VkBufferImageCopy2

set

public VkBufferImageCopy2KHR set(VkBufferImageCopy2KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBufferImageCopy2KHR malloc()

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

calloc

public static VkBufferImageCopy2KHR calloc()

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

create

public static VkBufferImageCopy2KHR create()

Returns a new VkBufferImageCopy2KHR instance allocated with BufferUtils.

create

public static VkBufferImageCopy2KHR create(long address)

Returns a new VkBufferImageCopy2KHR instance for the specified memory address.

createSafe

public static @Nullable VkBufferImageCopy2KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBufferImageCopy2KHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBufferImageCopy2KHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBufferImageCopy2KHR.Buffer create(int capacity)

Returns a new VkBufferImageCopy2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBufferImageCopy2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkBufferImageCopy2KHR malloc(MemoryStack stack)

Returns a new VkBufferImageCopy2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkBufferImageCopy2KHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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