Package org.lwjgl.vulkan

Class VkPhysicalDeviceHostImageCopyFeatures

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceHostImageCopyFeatures>

org.lwjgl.vulkan.VkPhysicalDeviceHostImageCopyFeatures

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPhysicalDeviceHostImageCopyFeaturesEXT

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

Structure indicating support for copies to or from images from host memory.

Description

If the VkPhysicalDeviceHostImageCopyFeatures structure is included in the pNext chain of the VkPhysicalDeviceFeatures2 structure passed to GetPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. VkPhysicalDeviceHostImageCopyFeatures can also be used in the pNext chain of VkDeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES

Layout

 struct VkPhysicalDeviceHostImageCopyFeatures {
     VkStructureType sType();
     void * pNext();
     VkBool32 hostImageCopy();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceHostImageCopyFeatures.Buffer	An array of VkPhysicalDeviceHostImageCopyFeatures 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	HOSTIMAGECOPY	The struct member offsets.
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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceHostImageCopyFeatures	calloc()	Returns a new VkPhysicalDeviceHostImageCopyFeatures instance allocated with memCalloc.
static VkPhysicalDeviceHostImageCopyFeatures.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceHostImageCopyFeatures.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceHostImageCopyFeatures.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyFeatures.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceHostImageCopyFeatures	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyFeatures instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceHostImageCopyFeatures	create()	Returns a new VkPhysicalDeviceHostImageCopyFeatures instance allocated with BufferUtils.
static VkPhysicalDeviceHostImageCopyFeatures.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceHostImageCopyFeatures.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceHostImageCopyFeatures	create(long address)	Returns a new VkPhysicalDeviceHostImageCopyFeatures instance for the specified memory address.
static VkPhysicalDeviceHostImageCopyFeatures.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceHostImageCopyFeatures.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceHostImageCopyFeatures	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceHostImageCopyFeatures.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	hostImageCopy()	indicates that the implementation supports copying from host memory to images using the CopyMemoryToImage command, copying from images to host memory using the CopyImageToMemory command, and copying between images using the CopyImageToImage command.
VkPhysicalDeviceHostImageCopyFeatures	hostImageCopy(boolean value)	Sets the specified value to the hostImageCopy() field.
static VkPhysicalDeviceHostImageCopyFeatures	malloc()	Returns a new VkPhysicalDeviceHostImageCopyFeatures instance allocated with memAlloc.
static VkPhysicalDeviceHostImageCopyFeatures.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceHostImageCopyFeatures.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceHostImageCopyFeatures.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyFeatures.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceHostImageCopyFeatures	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyFeatures instance allocated on the specified MemoryStack.
static int	nhostImageCopy(long struct)	Unsafe version of hostImageCopy().
static void	nhostImageCopy(long struct, int value)	Unsafe version of hostImageCopy.
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPhysicalDeviceHostImageCopyFeatures	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceHostImageCopyFeatures	set(int sType, long pNext, boolean hostImageCopy)	Initializes this struct with the specified values.
VkPhysicalDeviceHostImageCopyFeatures	set(VkPhysicalDeviceHostImageCopyFeatures src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceHostImageCopyFeatures	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceHostImageCopyFeatures	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES value to the sType() 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.

HOSTIMAGECOPY

public static final int HOSTIMAGECOPY

The struct member offsets.

Constructor Details

VkPhysicalDeviceHostImageCopyFeatures

public VkPhysicalDeviceHostImageCopyFeatures(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

hostImageCopy

public boolean hostImageCopy()

indicates that the implementation supports copying from host memory to images using the CopyMemoryToImage command, copying from images to host memory using the CopyImageToMemory command, and copying between images using the CopyImageToImage command.

sType

public VkPhysicalDeviceHostImageCopyFeatures sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceHostImageCopyFeatures sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES value to the sType() field.

pNext

public VkPhysicalDeviceHostImageCopyFeatures pNext(long value)

Sets the specified value to the pNext() field.

hostImageCopy

public VkPhysicalDeviceHostImageCopyFeatures hostImageCopy(boolean value)

Sets the specified value to the hostImageCopy() field.

set

public VkPhysicalDeviceHostImageCopyFeatures set(int sType,
 long pNext,
 boolean hostImageCopy)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceHostImageCopyFeatures set(VkPhysicalDeviceHostImageCopyFeatures src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceHostImageCopyFeatures malloc()

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

calloc

public static VkPhysicalDeviceHostImageCopyFeatures calloc()

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

create

public static VkPhysicalDeviceHostImageCopyFeatures create()

Returns a new VkPhysicalDeviceHostImageCopyFeatures instance allocated with BufferUtils.

create

public static VkPhysicalDeviceHostImageCopyFeatures create(long address)

Returns a new VkPhysicalDeviceHostImageCopyFeatures instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceHostImageCopyFeatures createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceHostImageCopyFeatures.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceHostImageCopyFeatures.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceHostImageCopyFeatures.Buffer create(int capacity)

Returns a new VkPhysicalDeviceHostImageCopyFeatures.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceHostImageCopyFeatures.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceHostImageCopyFeatures instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nhostImageCopy

public static int nhostImageCopy(long struct)

Unsafe version of hostImageCopy().

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.

nhostImageCopy

public static void nhostImageCopy(long struct,
 int value)

Unsafe version of hostImageCopy.