Package org.lwjgl.vulkan

Class VkPhysicalDeviceHostImageCopyFeaturesEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceHostImageCopyFeaturesEXT>

org.lwjgl.vulkan.VkPhysicalDeviceHostImageCopyFeaturesEXT

All Implemented Interfaces:

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

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

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

Description

If the VkPhysicalDeviceHostImageCopyFeaturesEXT 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. VkPhysicalDeviceHostImageCopyFeaturesEXT 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_EXT

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer	An array of VkPhysicalDeviceHostImageCopyFeaturesEXT 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
VkPhysicalDeviceHostImageCopyFeaturesEXT(ByteBuffer container)	Creates a VkPhysicalDeviceHostImageCopyFeaturesEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceHostImageCopyFeaturesEXT	calloc()	Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated with memCalloc.
static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceHostImageCopyFeaturesEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceHostImageCopyFeaturesEXT	create()	Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated with BufferUtils.
static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceHostImageCopyFeaturesEXT	create(long address)	Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance for the specified memory address.
static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance at the specified memory.
static VkPhysicalDeviceHostImageCopyFeaturesEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceHostImageCopyFeaturesEXT.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 CopyMemoryToImageEXT command, copying from images to host memory using the CopyImageToMemoryEXT command, and copying between images using the CopyImageToImageEXT command.
VkPhysicalDeviceHostImageCopyFeaturesEXT	hostImageCopy(boolean value)	Sets the specified value to the hostImageCopy() field.
static VkPhysicalDeviceHostImageCopyFeaturesEXT	malloc()	Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated with memAlloc.
static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceHostImageCopyFeaturesEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT 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.
VkPhysicalDeviceHostImageCopyFeaturesEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceHostImageCopyFeaturesEXT	set(int sType, long pNext, boolean hostImageCopy)	Initializes this struct with the specified values.
VkPhysicalDeviceHostImageCopyFeaturesEXT	set(VkPhysicalDeviceHostImageCopyFeaturesEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceHostImageCopyFeaturesEXT	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceHostImageCopyFeaturesEXT	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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

VkPhysicalDeviceHostImageCopyFeaturesEXT

public VkPhysicalDeviceHostImageCopyFeaturesEXT(ByteBuffer container)

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

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 CopyMemoryToImageEXT command, copying from images to host memory using the CopyImageToMemoryEXT command, and copying between images using the CopyImageToImageEXT command.

sType

public VkPhysicalDeviceHostImageCopyFeaturesEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceHostImageCopyFeaturesEXT sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT value to the sType() field.

pNext

public VkPhysicalDeviceHostImageCopyFeaturesEXT pNext(long value)

Sets the specified value to the pNext() field.

hostImageCopy

public VkPhysicalDeviceHostImageCopyFeaturesEXT hostImageCopy(boolean value)

Sets the specified value to the hostImageCopy() field.

set

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

Initializes this struct with the specified values.

set

public VkPhysicalDeviceHostImageCopyFeaturesEXT set(VkPhysicalDeviceHostImageCopyFeaturesEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceHostImageCopyFeaturesEXT malloc()

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

calloc

public static VkPhysicalDeviceHostImageCopyFeaturesEXT calloc()

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

create

public static VkPhysicalDeviceHostImageCopyFeaturesEXT create()

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated with BufferUtils.

create

public static VkPhysicalDeviceHostImageCopyFeaturesEXT create(long address)

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance for the specified memory address.

createSafe

@Nullable
public static VkPhysicalDeviceHostImageCopyFeaturesEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer create(int capacity)

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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