Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceToolProperties

extends Struct<VkPhysicalDeviceToolProperties>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceToolPropertiesEXT
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure providing information about an active tool.
Valid Usage (Implicit)
See Also

GetPhysicalDeviceToolProperties, GetPhysicalDeviceToolPropertiesEXT

Layout


struct VkPhysicalDeviceToolProperties {
    VkStructureType sType;
    void * pNext;
    char name[VK_MAX_EXTENSION_NAME_SIZE];
    char version[VK_MAX_EXTENSION_NAME_SIZE];
    VkToolPurposeFlags purposes;
    char description[VK_MAX_DESCRIPTION_SIZE];
    char layer[VK_MAX_EXTENSION_NAME_SIZE];
}

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
DESCRIPTION

The struct member offsets.

public static final int
LAYER

The struct member offsets.

public static final int
NAME

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PURPOSES

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
VERSION

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkPhysicalDeviceToolProperties(long address, ByteBuffer container)

public
VkPhysicalDeviceToolProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceToolProperties
calloc()

Returns a new VkPhysicalDeviceToolProperties instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceToolProperties.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkPhysicalDeviceToolProperties instance allocated with BufferUtils.

public static VkPhysicalDeviceToolProperties
create(long address)

Returns a new VkPhysicalDeviceToolProperties instance for the specified memory address.

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

Returns a new VkPhysicalDeviceToolProperties.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceToolProperties.Buffer instance at the specified memory.

public static VkPhysicalDeviceToolProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
description()

a null-terminated UTF-8 string containing a description of the tool.

public String
descriptionString()

a null-terminated UTF-8 string containing a description of the tool.

public ByteBuffer
layer()

a null-terminated UTF-8 string containing the name of the layer implementing the tool, if the tool is implemented in a layer - otherwise it may be an empty string.

public String
layerString()

a null-terminated UTF-8 string containing the name of the layer implementing the tool, if the tool is implemented in a layer - otherwise it may be an empty string.

public static VkPhysicalDeviceToolProperties
malloc()

Returns a new VkPhysicalDeviceToolProperties instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceToolProperties.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceToolProperties instance allocated on the specified MemoryStack.

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

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

public ByteBuffer
name()

a null-terminated UTF-8 string containing the name of the tool.

public String
nameString()

a null-terminated UTF-8 string containing the name of the tool.

public static ByteBuffer
ndescription(long struct)

Unsafe version of description.

public static String
ndescriptionString(long struct)

Unsafe version of descriptionString.

public static ByteBuffer
nlayer(long struct)

Unsafe version of layer.

public static String
nlayerString(long struct)

Unsafe version of layerString.

public static ByteBuffer
nname(long struct)

Unsafe version of name.

public static String
nnameString(long struct)

Unsafe version of nameString.

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
npurposes(long struct)

Unsafe version of purposes.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static ByteBuffer
nversion(long struct)

Unsafe version of version.

public static String
nversionString(long struct)

Unsafe version of versionString.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPhysicalDeviceToolProperties
pNext(long value)

Sets the specified value to the pNext field.

public int
purposes()

a bitmask of VkToolPurposeFlagBits which is populated with purposes supported by the tool.

public VkPhysicalDeviceToolProperties
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkPhysicalDeviceToolProperties

Returns:

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

Sets the specified value to the sType field.

public VkPhysicalDeviceToolProperties
public ByteBuffer
version()

a null-terminated UTF-8 string containing the version of the tool.

public String
versionString()

a null-terminated UTF-8 string containing the version of the tool.

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.

DESCRIPTIONback to summary
public static final int DESCRIPTION

The struct member offsets.

LAYERback to summary
public static final int LAYER

The struct member offsets.

NAMEback to summary
public static final int NAME

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PURPOSESback to summary
public static final int PURPOSES

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.

VERSIONback to summary
public static final int VERSION

The struct member offsets.

Constructor Detail

VkPhysicalDeviceToolPropertiesback to summary
protected VkPhysicalDeviceToolProperties(long address, ByteBuffer container)
VkPhysicalDeviceToolPropertiesback to summary
public VkPhysicalDeviceToolProperties(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceToolProperties calloc(MemoryStack stack)

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

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

Returns a new VkPhysicalDeviceToolProperties instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceToolProperties create(long address)

Returns a new VkPhysicalDeviceToolProperties instance for the specified memory address.

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

Returns a new VkPhysicalDeviceToolProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceToolProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceToolProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
descriptionback to summary
public ByteBuffer description()

a null-terminated UTF-8 string containing a description of the tool.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
descriptionStringback to summary
public String descriptionString()

a null-terminated UTF-8 string containing a description of the tool.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
layerback to summary
public ByteBuffer layer()

a null-terminated UTF-8 string containing the name of the layer implementing the tool, if the tool is implemented in a layer - otherwise it may be an empty string.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
layerStringback to summary
public String layerString()

a null-terminated UTF-8 string containing the name of the layer implementing the tool, if the tool is implemented in a layer - otherwise it may be an empty string.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
mallocback to summary
public static VkPhysicalDeviceToolProperties malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceToolProperties malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceToolProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nameback to summary
public ByteBuffer name()

a null-terminated UTF-8 string containing the name of the tool.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
nameStringback to summary
public String nameString()

a null-terminated UTF-8 string containing the name of the tool.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
ndescriptionback to summary
public static ByteBuffer ndescription(long struct)

Unsafe version of description.

ndescriptionStringback to summary
public static String ndescriptionString(long struct)

Unsafe version of descriptionString.

nlayerback to summary
public static ByteBuffer nlayer(long struct)

Unsafe version of layer.

nlayerStringback to summary
public static String nlayerString(long struct)

Unsafe version of layerString.

nnameback to summary
public static ByteBuffer nname(long struct)

Unsafe version of name.

nnameStringback to summary
public static String nnameString(long struct)

Unsafe version of nameString.

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.

npurposesback to summary
public static int npurposes(long struct)

Unsafe version of purposes.

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.

nversionback to summary
public static ByteBuffer nversion(long struct)

Unsafe version of version.

nversionStringback to summary
public static String nversionString(long struct)

Unsafe version of versionString.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

purposesback to summary
public int purposes()

a bitmask of VkToolPurposeFlagBits which is populated with purposes supported by the tool.

Annotations
@NativeType:VkToolPurposeFlags
setback to summary
public VkPhysicalDeviceToolProperties set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceToolProperties set(VkPhysicalDeviceToolProperties src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceToolProperties

the source struct

Returns:VkPhysicalDeviceToolProperties

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_TOOL_PROPERTIES value to the sType field.

versionback to summary
public ByteBuffer version()

a null-terminated UTF-8 string containing the version of the tool.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
versionStringback to summary
public String versionString()

a null-terminated UTF-8 string containing the version of the tool.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceToolProperties.Buffer

extends StructBuffer<VkPhysicalDeviceToolProperties, VkPhysicalDeviceToolProperties.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceToolPropertiesEXT.Buffer

An array of VkPhysicalDeviceToolProperties structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceToolProperties

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceToolProperties.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
public ByteBuffer
public String

Returns:

the null-terminated string stored in the VkPhysicalDeviceToolProperties#description field.
descriptionString
()

protected VkPhysicalDeviceToolProperties
public ByteBuffer

Returns:

a ByteBuffer view of the VkPhysicalDeviceToolProperties#layer field.
layer
()

public String

Returns:

the null-terminated string stored in the VkPhysicalDeviceToolProperties#layer field.
layerString
()

public ByteBuffer

Returns:

a ByteBuffer view of the VkPhysicalDeviceToolProperties#name field.
name
()

public String

Returns:

the null-terminated string stored in the VkPhysicalDeviceToolProperties#name field.
nameString
()

public long

Returns:

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

public VkPhysicalDeviceToolProperties.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceToolProperties#pNext field.

public int

Returns:

the value of the VkPhysicalDeviceToolProperties#purposes field.
purposes
()

protected VkPhysicalDeviceToolProperties.Buffer
public int

Returns:

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

public VkPhysicalDeviceToolProperties.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceToolProperties#sType field.

public VkPhysicalDeviceToolProperties.Buffer
public ByteBuffer
public String

Returns:

the null-terminated string stored in the VkPhysicalDeviceToolProperties#version field.
versionString
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceToolProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceToolProperties.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 VkPhysicalDeviceToolProperties#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

descriptionback to summary
public ByteBuffer description()
Returns:ByteBuffer

a ByteBuffer view of the VkPhysicalDeviceToolProperties#description field.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
descriptionStringback to summary
public String descriptionString()
Returns:String

the null-terminated string stored in the VkPhysicalDeviceToolProperties#description field.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
getElementFactoryback to summary
protected VkPhysicalDeviceToolProperties getElementFactory()

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

Annotations
@Override
layerback to summary
public ByteBuffer layer()
Returns:ByteBuffer

a ByteBuffer view of the VkPhysicalDeviceToolProperties#layer field.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
layerStringback to summary
public String layerString()
Returns:String

the null-terminated string stored in the VkPhysicalDeviceToolProperties#layer field.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

a ByteBuffer view of the VkPhysicalDeviceToolProperties#name field.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
nameStringback to summary
public String nameString()
Returns:String

the null-terminated string stored in the VkPhysicalDeviceToolProperties#name field.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
pNextback to summary
public long pNext()
Returns:long

the value of the VkPhysicalDeviceToolProperties#pNext field.

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

Sets the specified value to the VkPhysicalDeviceToolProperties#pNext field.

purposesback to summary
public int purposes()
Returns:int

the value of the VkPhysicalDeviceToolProperties#purposes field.

Annotations
@NativeType:VkToolPurposeFlags
selfback to summary
protected VkPhysicalDeviceToolProperties.Buffer self()

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

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

the value of the VkPhysicalDeviceToolProperties#sType field.

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

Sets the specified value to the VkPhysicalDeviceToolProperties#sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_TOOL_PROPERTIES value to the VkPhysicalDeviceToolProperties#sType field.

versionback to summary
public ByteBuffer version()
Returns:ByteBuffer

a ByteBuffer view of the VkPhysicalDeviceToolProperties#version field.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
versionStringback to summary
public String versionString()
Returns:String

the null-terminated string stored in the VkPhysicalDeviceToolProperties#version field.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]