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 and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkCopyCommandTransformInfoQCOM.Buffer An array of `VkCopyCommandTransformInfoQCOM` structs.

Field Summary

Modifier and Type	Field 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	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.
public static final int	TRANSFORM The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkCopyCommandTransformInfoQCOM(long address, ByteBuffer container)
public	VkCopyCommandTransformInfoQCOM(ByteBuffer container) Creates a `VkCopyCommandTransformInfoQCOM` instance at the current position of the specified `ByteBuffer` container.

Method Summary

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

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

TRANSFORM	back to summary
public static final int TRANSFORM The struct member offsets.

Constructor Detail

VkCopyCommandTransformInfoQCOM	back to summary
protected VkCopyCommandTransformInfoQCOM(long address, ByteBuffer container)

VkCopyCommandTransformInfoQCOM back to summary

VkCopyCommandTransformInfoQCOM	back to summary
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.

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 Detail

calloc	back to summary
public static VkCopyCommandTransformInfoQCOM calloc() Returns a new `VkCopyCommandTransformInfoQCOM` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkCopyCommandTransformInfoQCOM.Buffer calloc(int capacity) Returns a new `VkCopyCommandTransformInfoQCOM.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkCopyCommandTransformInfoQCOM.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkCopyCommandTransformInfoQCOM calloc(MemoryStack stack) Returns a new `VkCopyCommandTransformInfoQCOM` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkCopyCommandTransformInfoQCOM calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkCopyCommandTransformInfoQCOM.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkCopyCommandTransformInfoQCOM.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

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

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

create back to summary

create	back to summary
protected VkCopyCommandTransformInfoQCOM 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

protected VkCopyCommandTransformInfoQCOM 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

create	back to summary
public static VkCopyCommandTransformInfoQCOM create() Returns a new `VkCopyCommandTransformInfoQCOM` instance allocated with `BufferUtils`.

create	back to summary
public static VkCopyCommandTransformInfoQCOM create(long address) Returns a new `VkCopyCommandTransformInfoQCOM` instance for the specified memory address.

create back to summary

create	back to summary
public static VkCopyCommandTransformInfoQCOM.Buffer create(int capacity) Returns a new `VkCopyCommandTransformInfoQCOM.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkCopyCommandTransformInfoQCOM.Buffer create(int capacity)

Returns a new VkCopyCommandTransformInfoQCOM.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkCopyCommandTransformInfoQCOM.Buffer create(long address, int capacity) Create a `VkCopyCommandTransformInfoQCOM.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkCopyCommandTransformInfoQCOM.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkCopyCommandTransformInfoQCOM createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkCopyCommandTransformInfoQCOM createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkCopyCommandTransformInfoQCOM.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static VkCopyCommandTransformInfoQCOM malloc() Returns a new `VkCopyCommandTransformInfoQCOM` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkCopyCommandTransformInfoQCOM.Buffer malloc(int capacity) Returns a new `VkCopyCommandTransformInfoQCOM.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkCopyCommandTransformInfoQCOM.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkCopyCommandTransformInfoQCOM malloc(MemoryStack stack) Returns a new `VkCopyCommandTransformInfoQCOM` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkCopyCommandTransformInfoQCOM malloc(MemoryStack stack)

Returns a new VkCopyCommandTransformInfoQCOM instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkCopyCommandTransformInfoQCOM.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkCopyCommandTransformInfoQCOM.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

ntransform	back to summary
public static int ntransform(long struct) Unsafe version of `transform`.

ntransform	back to summary
public static void ntransform(long struct, int value) Unsafe version of `transform`.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void const *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

pNext	back to summary
public VkCopyCommandTransformInfoQCOM pNext(long value) Sets the specified value to the `pNext` field.

set	back to summary
public VkCopyCommandTransformInfoQCOM set(int sType, long pNext, int transform) Initializes this struct with the specified values.

set	back to summary
public VkCopyCommandTransformInfoQCOM set(VkCopyCommandTransformInfoQCOM src) Copies the specified struct data to this struct. Parameters src:VkCopyCommandTransformInfoQCOM the source struct Returns:VkCopyCommandTransformInfoQCOM this struct

set

back to summary

public VkCopyCommandTransformInfoQCOM set(VkCopyCommandTransformInfoQCOM src)

Copies the specified struct data to this struct.

Parameters

src:VkCopyCommandTransformInfoQCOM: the source struct

Returns:VkCopyCommandTransformInfoQCOM

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

sType back to summary

sType	back to summary
public int sType() a `VkStructureType` value identifying this structure. Annotations @NativeType:VkStructureType

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkCopyCommandTransformInfoQCOM sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkCopyCommandTransformInfoQCOM sType$Default() Sets the `STRUCTURE_TYPE_COPY_COMMAND_TRANSFORM_INFO_QCOM` value to the `sType` field.

transform back to summary

transform	back to summary
public int transform() a `VkSurfaceTransformFlagBitsKHR` value describing the transform to be applied. Annotations @NativeType:VkSurfaceTransformFlagBitsKHR

public int transform()

a VkSurfaceTransformFlagBitsKHR value describing the transform to be applied.

Annotations

@NativeType:VkSurfaceTransformFlagBitsKHR

transform	back to summary
public VkCopyCommandTransformInfoQCOM transform(int value) Sets the specified value to the `transform` field.

org.lwjgl.vulkan back to summary

public Class VkCopyCommandTransformInfoQCOM.Buffer

Class Inheritance

extends StructBuffer<VkCopyCommandTransformInfoQCOM, VkCopyCommandTransformInfoQCOM.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkCopyCommandTransformInfoQCOM.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkCopyCommandTransformInfoQCOM structs.

Field Summary

Modifier and Type	Field and Description
private static final VkCopyCommandTransformInfoQCOM	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkCopyCommandTransformInfoQCOM.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 Type	Method and Description
protected VkCopyCommandTransformInfoQCOM	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkCopyCommandTransformInfoQCOM#pNext` field. pNext()
public VkCopyCommandTransformInfoQCOM.Buffer	pNext(long value) Sets the specified value to the `VkCopyCommandTransformInfoQCOM#pNext` field.
protected VkCopyCommandTransformInfoQCOM.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkCopyCommandTransformInfoQCOM#sType` field. sType()
public VkCopyCommandTransformInfoQCOM.Buffer	sType(int value) Sets the specified value to the `VkCopyCommandTransformInfoQCOM#sType` field.
public VkCopyCommandTransformInfoQCOM.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_COPY_COMMAND_TRANSFORM_INFO_QCOM` value to the `VkCopyCommandTransformInfoQCOM#sType` field.
public int	Returns: the value of the `VkCopyCommandTransformInfoQCOM#transform` field. transform()
public VkCopyCommandTransformInfoQCOM.Buffer	transform(int value) Sets the specified value to the `VkCopyCommandTransformInfoQCOM#transform` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkCopyCommandTransformInfoQCOM ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkCopyCommandTransformInfoQCOM.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 `VkCopyCommandTransformInfoQCOM#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkCopyCommandTransformInfoQCOM.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 VkCopyCommandTransformInfoQCOM#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory	back to summary
protected VkCopyCommandTransformInfoQCOM getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected VkCopyCommandTransformInfoQCOM getElementFactory()

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

Annotations

@Override

pNext	back to summary
public long pNext() Returns:long the value of the `VkCopyCommandTransformInfoQCOM#pNext` field. Annotations @NativeType:void const *

pNext	back to summary
public VkCopyCommandTransformInfoQCOM.Buffer pNext(long value) Sets the specified value to the `VkCopyCommandTransformInfoQCOM#pNext` field.

self

back to summary

protected VkCopyCommandTransformInfoQCOM.Buffer self()

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

Annotations

@Override

sType	back to summary
public int sType() Returns:int the value of the `VkCopyCommandTransformInfoQCOM#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkCopyCommandTransformInfoQCOM.Buffer sType(int value) Sets the specified value to the `VkCopyCommandTransformInfoQCOM#sType` field.

sType$Default	back to summary
public VkCopyCommandTransformInfoQCOM.Buffer sType$Default() Sets the `STRUCTURE_TYPE_COPY_COMMAND_TRANSFORM_INFO_QCOM` value to the `VkCopyCommandTransformInfoQCOM#sType` field.

transform	back to summary
public int transform() Returns:int the value of the `VkCopyCommandTransformInfoQCOM#transform` field. Annotations @NativeType:VkSurfaceTransformFlagBitsKHR

transform	back to summary
public VkCopyCommandTransformInfoQCOM.Buffer transform(int value) Sets the specified value to the `VkCopyCommandTransformInfoQCOM#transform` field.