Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkHostImageCopyDevicePerformanceQueryEXT

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

Struct containing information about optimality of device access.
Description

The implementation may return FALSE in optimalDeviceAccess if identicalMemoryLayout is FALSE. If identicalMemoryLayout is TRUE, optimalDeviceAccess must be TRUE.

The implementation may return TRUE in optimalDeviceAccess while identicalMemoryLayout is FALSE. In this situation, any device performance impact should not be measurable.

If VkPhysicalDeviceImageFormatInfo2::format is a block-compressed format and GetPhysicalDeviceImageFormatProperties2 returns SUCCESS, the implementation must return TRUE in optimalDeviceAccess.

Note

Applications can make use of optimalDeviceAccess to determine their resource copying strategy. If a resource is expected to be accessed more on device than on the host, and the implementation considers the resource sub-optimally accessed, it is likely better to use device copies instead.

Note

Layout not being identical yet still considered optimal for device access could happen if the implementation has different memory layout patterns, some of which are easier to access on the host.

Note

The most practical reason for optimalDeviceAccess to be FALSE is that host image access may disable framebuffer compression where it would otherwise have been enabled. This represents far more efficient host image access since no compression algorithm is required to read or write to the image, but it would impact device access performance. Some implementations may only set optimalDeviceAccess to FALSE if certain conditions are met, such as specific image usage flags or creation flags.

Valid Usage (Implicit)

Layout


struct VkHostImageCopyDevicePerformanceQueryEXT {
    VkStructureType sType;
    void * pNext;
    VkBool32 optimalDeviceAccess;
    VkBool32 identicalMemoryLayout;
}

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
IDENTICALMEMORYLAYOUT

The struct member offsets.

public static final int
OPTIMALDEVICEACCESS

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
VkHostImageCopyDevicePerformanceQueryEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkHostImageCopyDevicePerformanceQueryEXT
calloc()

Returns a new VkHostImageCopyDevicePerformanceQueryEXT instance allocated with memCalloc.

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

Returns a new VkHostImageCopyDevicePerformanceQueryEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkHostImageCopyDevicePerformanceQueryEXT instance allocated with BufferUtils.

public static VkHostImageCopyDevicePerformanceQueryEXT
create(long address)

Returns a new VkHostImageCopyDevicePerformanceQueryEXT instance for the specified memory address.

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

Returns a new VkHostImageCopyDevicePerformanceQueryEXT.Buffer instance allocated with BufferUtils.

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

Create a VkHostImageCopyDevicePerformanceQueryEXT.Buffer instance at the specified memory.

public static VkHostImageCopyDevicePerformanceQueryEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean
identicalMemoryLayout()

returns TRUE if use of host image copy has no impact on memory layout compared to an image that is created with exact same creation parameters, and bound to the same VkDeviceMemory, except that IMAGE_USAGE_HOST_TRANSFER_BIT_EXT is replaced with IMAGE_USAGE_TRANSFER_SRC_BIT and IMAGE_USAGE_TRANSFER_DST_BIT.

public static VkHostImageCopyDevicePerformanceQueryEXT
malloc()

Returns a new VkHostImageCopyDevicePerformanceQueryEXT instance allocated with memAlloc.

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

Returns a new VkHostImageCopyDevicePerformanceQueryEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkHostImageCopyDevicePerformanceQueryEXT instance allocated on the specified MemoryStack.

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

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

public static int
nidenticalMemoryLayout(long struct)

Unsafe version of identicalMemoryLayout.

public static int
noptimalDeviceAccess(long struct)

Unsafe version of optimalDeviceAccess.

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 boolean
optimalDeviceAccess()

returns TRUE if use of host image copy has no adverse effect on device access performance, compared to an image that is created with exact same creation parameters, and bound to the same VkDeviceMemory, except that IMAGE_USAGE_HOST_TRANSFER_BIT_EXT is replaced with IMAGE_USAGE_TRANSFER_SRC_BIT and IMAGE_USAGE_TRANSFER_DST_BIT.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkHostImageCopyDevicePerformanceQueryEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkHostImageCopyDevicePerformanceQueryEXT
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkHostImageCopyDevicePerformanceQueryEXT

Returns:

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

Sets the specified value to the sType field.

public VkHostImageCopyDevicePerformanceQueryEXT
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.

IDENTICALMEMORYLAYOUTback to summary
public static final int IDENTICALMEMORYLAYOUT

The struct member offsets.

OPTIMALDEVICEACCESSback to summary
public static final int OPTIMALDEVICEACCESS

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

VkHostImageCopyDevicePerformanceQueryEXTback to summary
protected VkHostImageCopyDevicePerformanceQueryEXT(long address, ByteBuffer container)
VkHostImageCopyDevicePerformanceQueryEXTback to summary
public VkHostImageCopyDevicePerformanceQueryEXT(ByteBuffer container)

Creates a VkHostImageCopyDevicePerformanceQueryEXT 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 VkHostImageCopyDevicePerformanceQueryEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkHostImageCopyDevicePerformanceQueryEXT calloc(MemoryStack stack)

Returns a new VkHostImageCopyDevicePerformanceQueryEXT 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 VkHostImageCopyDevicePerformanceQueryEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new VkHostImageCopyDevicePerformanceQueryEXT instance allocated with BufferUtils.

createback to summary
public static VkHostImageCopyDevicePerformanceQueryEXT create(long address)

Returns a new VkHostImageCopyDevicePerformanceQueryEXT instance for the specified memory address.

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

Returns a new VkHostImageCopyDevicePerformanceQueryEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkHostImageCopyDevicePerformanceQueryEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkHostImageCopyDevicePerformanceQueryEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
identicalMemoryLayoutback to summary
public boolean identicalMemoryLayout()

returns TRUE if use of host image copy has no impact on memory layout compared to an image that is created with exact same creation parameters, and bound to the same VkDeviceMemory, except that IMAGE_USAGE_HOST_TRANSFER_BIT_EXT is replaced with IMAGE_USAGE_TRANSFER_SRC_BIT and IMAGE_USAGE_TRANSFER_DST_BIT.

Annotations
@NativeType:VkBool32
mallocback to summary
public static VkHostImageCopyDevicePerformanceQueryEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkHostImageCopyDevicePerformanceQueryEXT malloc(MemoryStack stack)

Returns a new VkHostImageCopyDevicePerformanceQueryEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nidenticalMemoryLayoutback to summary
public static int nidenticalMemoryLayout(long struct)

Unsafe version of identicalMemoryLayout.

noptimalDeviceAccessback to summary
public static int noptimalDeviceAccess(long struct)

Unsafe version of optimalDeviceAccess.

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.

optimalDeviceAccessback to summary
public boolean optimalDeviceAccess()

returns TRUE if use of host image copy has no adverse effect on device access performance, compared to an image that is created with exact same creation parameters, and bound to the same VkDeviceMemory, except that IMAGE_USAGE_HOST_TRANSFER_BIT_EXT is replaced with IMAGE_USAGE_TRANSFER_SRC_BIT and IMAGE_USAGE_TRANSFER_DST_BIT.

Annotations
@NativeType:VkBool32
pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkHostImageCopyDevicePerformanceQueryEXT set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkHostImageCopyDevicePerformanceQueryEXT set(VkHostImageCopyDevicePerformanceQueryEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkHostImageCopyDevicePerformanceQueryEXT

the source struct

Returns:VkHostImageCopyDevicePerformanceQueryEXT

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 VkHostImageCopyDevicePerformanceQueryEXT sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkHostImageCopyDevicePerformanceQueryEXT.Buffer

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

An array of VkHostImageCopyDevicePerformanceQueryEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkHostImageCopyDevicePerformanceQueryEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkHostImageCopyDevicePerformanceQueryEXT.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 VkHostImageCopyDevicePerformanceQueryEXT
public boolean
public boolean
public long

Returns:

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

public VkHostImageCopyDevicePerformanceQueryEXT.Buffer
pNext(long value)

Sets the specified value to the VkHostImageCopyDevicePerformanceQueryEXT#pNext field.

protected VkHostImageCopyDevicePerformanceQueryEXT.Buffer
public int

Returns:

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

public VkHostImageCopyDevicePerformanceQueryEXT.Buffer
sType(int value)

Sets the specified value to the VkHostImageCopyDevicePerformanceQueryEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkHostImageCopyDevicePerformanceQueryEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkHostImageCopyDevicePerformanceQueryEXT.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 VkHostImageCopyDevicePerformanceQueryEXT#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 VkHostImageCopyDevicePerformanceQueryEXT getElementFactory()

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

Annotations
@Override
identicalMemoryLayoutback to summary
public boolean identicalMemoryLayout()
Returns:boolean

the value of the VkHostImageCopyDevicePerformanceQueryEXT#identicalMemoryLayout field.

Annotations
@NativeType:VkBool32
optimalDeviceAccessback to summary
public boolean optimalDeviceAccess()
Returns:boolean

the value of the VkHostImageCopyDevicePerformanceQueryEXT#optimalDeviceAccess field.

Annotations
@NativeType:VkBool32
pNextback to summary
public long pNext()
Returns:long

the value of the VkHostImageCopyDevicePerformanceQueryEXT#pNext field.

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

Sets the specified value to the VkHostImageCopyDevicePerformanceQueryEXT#pNext field.

selfback to summary
protected VkHostImageCopyDevicePerformanceQueryEXT.Buffer self()

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

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

the value of the VkHostImageCopyDevicePerformanceQueryEXT#sType field.

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

Sets the specified value to the VkHostImageCopyDevicePerformanceQueryEXT#sType field.

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

Sets the STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT value to the VkHostImageCopyDevicePerformanceQueryEXT#sType field.