Package org.lwjgl.vulkan

Class VkCopyCommandTransformInfoQCOM

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyCommandTransformInfoQCOM>

org.lwjgl.vulkan.VkCopyCommandTransformInfoQCOM

All Implemented Interfaces:

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

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

Structure describing transform parameters of rotated copy command.

Description

Including this structure in the pNext chain of VkBufferImageCopy2 defines a rotation to be performed when copying between an image and a buffer. Including this structure in the pNext chain of VkBlitImageInfo2 defines a rotation to be performed when blitting between two images. If this structure is not specified in either case, the implementation behaves as if it was specified with a transform equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR.

Specifying a transform for a copy between an image and a buffer rotates the region accessed in the image around the offset. Specifying a transform for a blit performs a similar transform as described in Image Blits with Scaling and Rotation.

Rotations other than SURFACE_TRANSFORM_IDENTITY_BIT_KHR can only be specified for single-plane 2D images with a 1x1x1 texel block extent.

Valid Usage

• transform must be SURFACE_TRANSFORM_IDENTITY_BIT_KHR, SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_COMMAND_TRANSFORM_INFO_QCOM

Layout

 struct VkCopyCommandTransformInfoQCOM {
     VkStructureType sType();
     void const * pNext();
     VkSurfaceTransformFlagBitsKHR transform();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkCopyCommandTransformInfoQCOM.Buffer	An array of VkCopyCommandTransformInfoQCOM 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	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	TRANSFORM	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
VkCopyCommandTransformInfoQCOM(ByteBuffer container)	Creates a VkCopyCommandTransformInfoQCOM instance at the current position of the specified ByteBuffer container.

Method Summary

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

TRANSFORM

public static final int TRANSFORM

The struct member offsets.

Constructor Details

VkCopyCommandTransformInfoQCOM

public VkCopyCommandTransformInfoQCOM(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

transform

public int transform()

a VkSurfaceTransformFlagBitsKHR value describing the transform to be applied.

sType

public VkCopyCommandTransformInfoQCOM sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkCopyCommandTransformInfoQCOM sType$Default()

Sets the STRUCTURE_TYPE_COPY_COMMAND_TRANSFORM_INFO_QCOM value to the sType() field.

pNext

public VkCopyCommandTransformInfoQCOM pNext(long value)

Sets the specified value to the pNext() field.

transform

public VkCopyCommandTransformInfoQCOM transform(int value)

Sets the specified value to the transform() field.

set

public VkCopyCommandTransformInfoQCOM set(int sType,
 long pNext,
 int transform)

Initializes this struct with the specified values.

set

public VkCopyCommandTransformInfoQCOM set(VkCopyCommandTransformInfoQCOM src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyCommandTransformInfoQCOM malloc()

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

calloc

public static VkCopyCommandTransformInfoQCOM calloc()

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

create

public static VkCopyCommandTransformInfoQCOM create()

Returns a new VkCopyCommandTransformInfoQCOM instance allocated with BufferUtils.

create

public static VkCopyCommandTransformInfoQCOM create(long address)

Returns a new VkCopyCommandTransformInfoQCOM instance for the specified memory address.

createSafe

public static @Nullable VkCopyCommandTransformInfoQCOM createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyCommandTransformInfoQCOM.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyCommandTransformInfoQCOM.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyCommandTransformInfoQCOM.Buffer create(int capacity)

Returns a new VkCopyCommandTransformInfoQCOM.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyCommandTransformInfoQCOM.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkCopyCommandTransformInfoQCOM instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntransform

public static int ntransform(long struct)

Unsafe version of transform().

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.

ntransform

public static void ntransform(long struct,
 int value)

Unsafe version of transform.