Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExternalImageFormatProperties

extends Struct<VkExternalImageFormatProperties>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkExternalImageFormatPropertiesKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying supported external handle properties.
Valid Usage (Implicit)
See Also

VkExternalMemoryProperties

Layout


struct VkExternalImageFormatProperties {
    VkStructureType sType;
    void * pNext;
    VkExternalMemoryProperties externalMemoryProperties;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkExternalImageFormatProperties.Buffer

An array of VkExternalImageFormatProperties structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
EXTERNALMEMORYPROPERTIES

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
VkExternalImageFormatProperties(long address, ByteBuffer container)

public
VkExternalImageFormatProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExternalImageFormatProperties
calloc()

Returns a new VkExternalImageFormatProperties instance allocated with memCalloc.

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

Returns a new VkExternalImageFormatProperties.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkExternalImageFormatProperties
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatProperties
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatProperties.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatProperties.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkExternalImageFormatProperties
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 VkExternalImageFormatProperties
create()

Returns a new VkExternalImageFormatProperties instance allocated with BufferUtils.

public static VkExternalImageFormatProperties
create(long address)

Returns a new VkExternalImageFormatProperties instance for the specified memory address.

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

Returns a new VkExternalImageFormatProperties.Buffer instance allocated with BufferUtils.

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

Create a VkExternalImageFormatProperties.Buffer instance at the specified memory.

public static VkExternalImageFormatProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public VkExternalMemoryProperties
externalMemoryProperties()

a VkExternalMemoryProperties structure specifying various capabilities of the external handle type when used with the specified image creation parameters.

public static VkExternalImageFormatProperties
malloc()

Returns a new VkExternalImageFormatProperties instance allocated with memAlloc.

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

Returns a new VkExternalImageFormatProperties.Buffer instance allocated with memAlloc.

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

Returns a new VkExternalImageFormatProperties instance allocated on the specified MemoryStack.

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

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

public static VkExternalImageFormatProperties
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatProperties
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatProperties.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatProperties.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalMemoryProperties
nexternalMemoryProperties(long struct)

Unsafe version of externalMemoryProperties.

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

Sets the specified value to the pNext field.

public VkExternalImageFormatProperties
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkExternalImageFormatProperties

Returns:

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

Sets the specified value to the sType field.

public VkExternalImageFormatProperties
sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES value to the sType field.

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.

EXTERNALMEMORYPROPERTIESback to summary
public static final int EXTERNALMEMORYPROPERTIES

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

VkExternalImageFormatPropertiesback to summary
protected VkExternalImageFormatProperties(long address, ByteBuffer container)
VkExternalImageFormatPropertiesback to summary
public VkExternalImageFormatProperties(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExternalImageFormatProperties calloc(MemoryStack stack)

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

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

callocStackback to summary
public static VkExternalImageFormatProperties callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkExternalImageFormatProperties callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkExternalImageFormatProperties.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkExternalImageFormatProperties.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkExternalImageFormatProperties 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 VkExternalImageFormatProperties create()

Returns a new VkExternalImageFormatProperties instance allocated with BufferUtils.

createback to summary
public static VkExternalImageFormatProperties create(long address)

Returns a new VkExternalImageFormatProperties instance for the specified memory address.

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

Returns a new VkExternalImageFormatProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExternalImageFormatProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExternalImageFormatProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
externalMemoryPropertiesback to summary
public VkExternalMemoryProperties externalMemoryProperties()

a VkExternalMemoryProperties structure specifying various capabilities of the external handle type when used with the specified image creation parameters.

mallocback to summary
public static VkExternalImageFormatProperties malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExternalImageFormatProperties malloc(MemoryStack stack)

Returns a new VkExternalImageFormatProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkExternalImageFormatProperties mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkExternalImageFormatProperties mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkExternalImageFormatProperties.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkExternalImageFormatProperties.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nexternalMemoryPropertiesback to summary
public static VkExternalMemoryProperties nexternalMemoryProperties(long struct)

Unsafe version of externalMemoryProperties.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkExternalImageFormatProperties set(VkExternalImageFormatProperties src)

Copies the specified struct data to this struct.

Parameters
src:VkExternalImageFormatProperties

the source struct

Returns:VkExternalImageFormatProperties

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkExternalImageFormatProperties.Buffer

extends StructBuffer<VkExternalImageFormatProperties, VkExternalImageFormatProperties.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkExternalImageFormatPropertiesKHR.Buffer
An array of VkExternalImageFormatProperties structs.

Field Summary

Modifier and TypeField and Description
private static final VkExternalImageFormatProperties
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkExternalImageFormatProperties.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 VkExternalMemoryProperties

Returns:

a VkExternalMemoryProperties view of the VkExternalImageFormatProperties#externalMemoryProperties field.
externalMemoryProperties()

protected VkExternalImageFormatProperties
getElementFactory()

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

public long

Returns:

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

public VkExternalImageFormatProperties.Buffer
pNext(long value)

Sets the specified value to the VkExternalImageFormatProperties#pNext field.

protected VkExternalImageFormatProperties.Buffer
self()

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

public int

Returns:

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

public VkExternalImageFormatProperties.Buffer
sType(int value)

Sets the specified value to the VkExternalImageFormatProperties#sType field.

public VkExternalImageFormatProperties.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES value to the VkExternalImageFormatProperties#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExternalImageFormatProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

externalMemoryPropertiesback to summary
public VkExternalMemoryProperties externalMemoryProperties()
Returns:VkExternalMemoryProperties

a VkExternalMemoryProperties view of the VkExternalImageFormatProperties#externalMemoryProperties field.

getElementFactoryback to summary
protected VkExternalImageFormatProperties getElementFactory()

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

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

the value of the VkExternalImageFormatProperties#pNext field.

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

Sets the specified value to the VkExternalImageFormatProperties#pNext field.

selfback to summary
protected VkExternalImageFormatProperties.Buffer self()

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

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

the value of the VkExternalImageFormatProperties#sType field.

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

Sets the specified value to the VkExternalImageFormatProperties#sType field.

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

Sets the STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES value to the VkExternalImageFormatProperties#sType field.