Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceHostImageCopyFeaturesEXT

extends Struct<VkPhysicalDeviceHostImageCopyFeaturesEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HOSTIMAGECOPY

The struct member offsets.

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.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkPhysicalDeviceHostImageCopyFeaturesEXT(ByteBuffer container)

Creates a VkPhysicalDeviceHostImageCopyFeaturesEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceHostImageCopyFeaturesEXT
calloc()

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated with memCalloc.

public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance allocated with memCalloc.

public static VkPhysicalDeviceHostImageCopyFeaturesEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkPhysicalDeviceHostImageCopyFeaturesEXT
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 VkPhysicalDeviceHostImageCopyFeaturesEXT
create()

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated with BufferUtils.

public static VkPhysicalDeviceHostImageCopyFeaturesEXT
create(long address)

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance for the specified memory address.

public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance at the specified memory.

public static VkPhysicalDeviceHostImageCopyFeaturesEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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.

public VkPhysicalDeviceHostImageCopyFeaturesEXT
hostImageCopy(boolean value)

Sets the specified value to the hostImageCopy field.

public static VkPhysicalDeviceHostImageCopyFeaturesEXT
malloc()

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated with memAlloc.

public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance allocated with memAlloc.

public static VkPhysicalDeviceHostImageCopyFeaturesEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated on the specified MemoryStack.

public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static int
nhostImageCopy(long struct)

Unsafe version of hostImageCopy.

public static void
nhostImageCopy(long struct, int value)

Unsafe version of hostImageCopy.

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 long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPhysicalDeviceHostImageCopyFeaturesEXT
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkPhysicalDeviceHostImageCopyFeaturesEXT

Returns:

this struct
set
(VkPhysicalDeviceHostImageCopyFeaturesEXT
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 VkPhysicalDeviceHostImageCopyFeaturesEXT
sType(int value)

Sets the specified value to the sType field.

public VkPhysicalDeviceHostImageCopyFeaturesEXT
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

HOSTIMAGECOPYback to summary
public static final int HOSTIMAGECOPY

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkPhysicalDeviceHostImageCopyFeaturesEXTback to summary
protected VkPhysicalDeviceHostImageCopyFeaturesEXT(long address, ByteBuffer container)
VkPhysicalDeviceHostImageCopyFeaturesEXTback to summary
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 Detail

callocback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT calloc()

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

callocback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer calloc(int capacity, MemoryStack stack)

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

createback to summary
protected VkPhysicalDeviceHostImageCopyFeaturesEXT 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
createback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT create()

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT create(long address)

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance for the specified memory address.

createback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer create(int capacity)

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
hostImageCopyback to summary
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.

Annotations
@NativeType:VkBool32
hostImageCopyback to summary
public VkPhysicalDeviceHostImageCopyFeaturesEXT hostImageCopy(boolean value)

Sets the specified value to the hostImageCopy field.

mallocback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT malloc()

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

mallocback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceHostImageCopyFeaturesEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nhostImageCopyback to summary
public static int nhostImageCopy(long struct)

Unsafe version of hostImageCopy.

nhostImageCopyback to summary
public static void nhostImageCopy(long struct, int value)

Unsafe version of hostImageCopy.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkPhysicalDeviceHostImageCopyFeaturesEXT pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceHostImageCopyFeaturesEXT set(VkPhysicalDeviceHostImageCopyFeaturesEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceHostImageCopyFeaturesEXT

the source struct

Returns:VkPhysicalDeviceHostImageCopyFeaturesEXT

this struct

sizeofback to summary
public int sizeof()

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

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

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPhysicalDeviceHostImageCopyFeaturesEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkPhysicalDeviceHostImageCopyFeaturesEXT sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer

extends StructBuffer<VkPhysicalDeviceHostImageCopyFeaturesEXT, VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkPhysicalDeviceHostImageCopyFeaturesEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceHostImageCopyFeaturesEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceHostImageCopyFeaturesEXT.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 TypeMethod and Description
protected VkPhysicalDeviceHostImageCopyFeaturesEXT
public boolean
public VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer
hostImageCopy(boolean value)

Sets the specified value to the VkPhysicalDeviceHostImageCopyFeaturesEXT#hostImageCopy field.

public long

Returns:

the value of the VkPhysicalDeviceHostImageCopyFeaturesEXT#pNext field.
pNext
()

public VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceHostImageCopyFeaturesEXT#pNext field.

protected VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer
public int

Returns:

the value of the VkPhysicalDeviceHostImageCopyFeaturesEXT#sType field.
sType
()

public VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceHostImageCopyFeaturesEXT#sType field.

public VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceHostImageCopyFeaturesEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

Method Detail

getElementFactoryback to summary
protected VkPhysicalDeviceHostImageCopyFeaturesEXT getElementFactory()

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

Annotations
@Override
hostImageCopyback to summary
public boolean hostImageCopy()
Returns:boolean

the value of the VkPhysicalDeviceHostImageCopyFeaturesEXT#hostImageCopy field.

Annotations
@NativeType:VkBool32
hostImageCopyback to summary
public VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer hostImageCopy(boolean value)

Sets the specified value to the VkPhysicalDeviceHostImageCopyFeaturesEXT#hostImageCopy field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkPhysicalDeviceHostImageCopyFeaturesEXT#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer pNext(long value)

Sets the specified value to the VkPhysicalDeviceHostImageCopyFeaturesEXT#pNext field.

selfback to summary
protected VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkPhysicalDeviceHostImageCopyFeaturesEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer sType(int value)

Sets the specified value to the VkPhysicalDeviceHostImageCopyFeaturesEXT#sType field.

sType$Defaultback to summary
public VkPhysicalDeviceHostImageCopyFeaturesEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT value to the VkPhysicalDeviceHostImageCopyFeaturesEXT#sType field.