Top Description Inners Fields Constructors Methods
org.lwjgl.util.ktx

public Class ktxVulkanFunctions

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

Struct for applications to pass Vulkan function pointers to the Texture_VkUpload functions via a ktxVulkanDeviceInfo struct.

vkGetInstanceProcAddr and vkGetDeviceProcAddr should be set, others are optional.

Layout


struct ktxVulkanFunctions {
    PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr;
    PFN_vkGetDeviceProcAddr vkGetDeviceProcAddr;
    PFN_vkAllocateCommandBuffers vkAllocateCommandBuffers;
    PFN_vkAllocateMemory vkAllocateMemory;
    PFN_vkBeginCommandBuffer vkBeginCommandBuffer;
    PFN_vkBindBufferMemory vkBindBufferMemory;
    PFN_vkBindImageMemory vkBindImageMemory;
    PFN_vkCmdBlitImage vkCmdBlitImage;
    PFN_vkCmdCopyBufferToImage vkCmdCopyBufferToImage;
    PFN_vkCmdPipelineBarrier vkCmdPipelineBarrier;
    PFN_vkCreateImage vkCreateImage;
    PFN_vkDestroyImage vkDestroyImage;
    PFN_vkCreateBuffer vkCreateBuffer;
    PFN_vkDestroyBuffer vkDestroyBuffer;
    PFN_vkCreateFence vkCreateFence;
    PFN_vkDestroyFence vkDestroyFence;
    PFN_vkEndCommandBuffer vkEndCommandBuffer;
    PFN_vkFreeCommandBuffers vkFreeCommandBuffers;
    PFN_vkFreeMemory vkFreeMemory;
    PFN_vkGetBufferMemoryRequirements vkGetBufferMemoryRequirements;
    PFN_vkGetImageMemoryRequirements vkGetImageMemoryRequirements;
    PFN_vkGetImageSubresourceLayout vkGetImageSubresourceLayout;
    PFN_vkGetPhysicalDeviceImageFormatProperties vkGetPhysicalDeviceImageFormatProperties;
    PFN_vkGetPhysicalDeviceFormatProperties vkGetPhysicalDeviceFormatProperties;
    PFN_vkGetPhysicalDeviceMemoryProperties vkGetPhysicalDeviceMemoryProperties;
    PFN_vkMapMemory vkMapMemory;
    PFN_vkQueueSubmit vkQueueSubmit;
    PFN_vkQueueWaitIdle vkQueueWaitIdle;
    PFN_vkUnmapMemory vkUnmapMemory;
    PFN_vkWaitForFences vkWaitForFences;
}

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
SIZEOF

The struct size in bytes.

public static final int
VKALLOCATECOMMANDBUFFERS

The struct member offsets.

public static final int
VKALLOCATEMEMORY

The struct member offsets.

public static final int
VKBEGINCOMMANDBUFFER

The struct member offsets.

public static final int
VKBINDBUFFERMEMORY

The struct member offsets.

public static final int
VKBINDIMAGEMEMORY

The struct member offsets.

public static final int
VKCMDBLITIMAGE

The struct member offsets.

public static final int
VKCMDCOPYBUFFERTOIMAGE

The struct member offsets.

public static final int
VKCMDPIPELINEBARRIER

The struct member offsets.

public static final int
VKCREATEBUFFER

The struct member offsets.

public static final int
VKCREATEFENCE

The struct member offsets.

public static final int
VKCREATEIMAGE

The struct member offsets.

public static final int
VKDESTROYBUFFER

The struct member offsets.

public static final int
VKDESTROYFENCE

The struct member offsets.

public static final int
VKDESTROYIMAGE

The struct member offsets.

public static final int
VKENDCOMMANDBUFFER

The struct member offsets.

public static final int
VKFREECOMMANDBUFFERS

The struct member offsets.

public static final int
VKFREEMEMORY

The struct member offsets.

public static final int
VKGETBUFFERMEMORYREQUIREMENTS

The struct member offsets.

public static final int
VKGETDEVICEPROCADDR

The struct member offsets.

public static final int
VKGETIMAGEMEMORYREQUIREMENTS

The struct member offsets.

public static final int
VKGETIMAGESUBRESOURCELAYOUT

The struct member offsets.

public static final int
VKGETINSTANCEPROCADDR

The struct member offsets.

public static final int
VKGETPHYSICALDEVICEFORMATPROPERTIES

The struct member offsets.

public static final int
VKGETPHYSICALDEVICEIMAGEFORMATPROPERTIES

The struct member offsets.

public static final int
VKGETPHYSICALDEVICEMEMORYPROPERTIES

The struct member offsets.

public static final int
VKMAPMEMORY

The struct member offsets.

public static final int
VKQUEUESUBMIT

The struct member offsets.

public static final int
VKQUEUEWAITIDLE

The struct member offsets.

public static final int
VKUNMAPMEMORY

The struct member offsets.

public static final int
VKWAITFORFENCES

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
ktxVulkanFunctions(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static ktxVulkanFunctions
calloc()

Returns a new ktxVulkanFunctions instance allocated with memCalloc.

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

Returns a new ktxVulkanFunctions.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new ktxVulkanFunctions instance allocated with BufferUtils.

public static ktxVulkanFunctions
create(long address)

Returns a new ktxVulkanFunctions instance for the specified memory address.

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

Returns a new ktxVulkanFunctions.Buffer instance allocated with BufferUtils.

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

Create a ktxVulkanFunctions.Buffer instance at the specified memory.

public static ktxVulkanFunctions
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static ktxVulkanFunctions
malloc()

Returns a new ktxVulkanFunctions instance allocated with memAlloc.

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

Returns a new ktxVulkanFunctions.Buffer instance allocated with memAlloc.

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

Returns a new ktxVulkanFunctions instance allocated on the specified MemoryStack.

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

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

public static long
nvkAllocateCommandBuffers(long struct)

Unsafe version of vkAllocateCommandBuffers.

public static void
nvkAllocateCommandBuffers(long struct, long value)

Unsafe version of vkAllocateCommandBuffers.

public static long
nvkAllocateMemory(long struct)

Unsafe version of vkAllocateMemory.

public static void
nvkAllocateMemory(long struct, long value)

Unsafe version of vkAllocateMemory.

public static long
nvkBeginCommandBuffer(long struct)

Unsafe version of vkBeginCommandBuffer.

public static void
nvkBeginCommandBuffer(long struct, long value)

Unsafe version of vkBeginCommandBuffer.

public static long
nvkBindBufferMemory(long struct)

Unsafe version of vkBindBufferMemory.

public static void
nvkBindBufferMemory(long struct, long value)

Unsafe version of vkBindBufferMemory.

public static long
nvkBindImageMemory(long struct)

Unsafe version of vkBindImageMemory.

public static void
nvkBindImageMemory(long struct, long value)

Unsafe version of vkBindImageMemory.

public static long
nvkCmdBlitImage(long struct)

Unsafe version of vkCmdBlitImage.

public static void
nvkCmdBlitImage(long struct, long value)

Unsafe version of vkCmdBlitImage.

public static long
nvkCmdCopyBufferToImage(long struct)

Unsafe version of vkCmdCopyBufferToImage.

public static void
nvkCmdCopyBufferToImage(long struct, long value)

Unsafe version of vkCmdCopyBufferToImage.

public static long
nvkCmdPipelineBarrier(long struct)

Unsafe version of vkCmdPipelineBarrier.

public static void
nvkCmdPipelineBarrier(long struct, long value)

Unsafe version of vkCmdPipelineBarrier.

public static long
nvkCreateBuffer(long struct)

Unsafe version of vkCreateBuffer.

public static void
nvkCreateBuffer(long struct, long value)

Unsafe version of vkCreateBuffer.

public static long
nvkCreateFence(long struct)

Unsafe version of vkCreateFence.

public static void
nvkCreateFence(long struct, long value)

Unsafe version of vkCreateFence.

public static long
nvkCreateImage(long struct)

Unsafe version of vkCreateImage.

public static void
nvkCreateImage(long struct, long value)

Unsafe version of vkCreateImage.

public static long
nvkDestroyBuffer(long struct)

Unsafe version of vkDestroyBuffer.

public static void
nvkDestroyBuffer(long struct, long value)

Unsafe version of vkDestroyBuffer.

public static long
nvkDestroyFence(long struct)

Unsafe version of vkDestroyFence.

public static void
nvkDestroyFence(long struct, long value)

Unsafe version of vkDestroyFence.

public static long
nvkDestroyImage(long struct)

Unsafe version of vkDestroyImage.

public static void
nvkDestroyImage(long struct, long value)

Unsafe version of vkDestroyImage.

public static long
nvkEndCommandBuffer(long struct)

Unsafe version of vkEndCommandBuffer.

public static void
nvkEndCommandBuffer(long struct, long value)

Unsafe version of vkEndCommandBuffer.

public static long
nvkFreeCommandBuffers(long struct)

Unsafe version of vkFreeCommandBuffers.

public static void
nvkFreeCommandBuffers(long struct, long value)

Unsafe version of vkFreeCommandBuffers.

public static long
nvkFreeMemory(long struct)

Unsafe version of vkFreeMemory.

public static void
nvkFreeMemory(long struct, long value)

Unsafe version of vkFreeMemory.

public static long
public static void
nvkGetBufferMemoryRequirements(long struct, long value)

Unsafe version of vkGetBufferMemoryRequirements.

public static long
nvkGetDeviceProcAddr(long struct)

Unsafe version of vkGetDeviceProcAddr.

public static void
nvkGetDeviceProcAddr(long struct, long value)

Unsafe version of vkGetDeviceProcAddr.

public static long
public static void
nvkGetImageMemoryRequirements(long struct, long value)

Unsafe version of vkGetImageMemoryRequirements.

public static long
public static void
nvkGetImageSubresourceLayout(long struct, long value)

Unsafe version of vkGetImageSubresourceLayout.

public static long
nvkGetInstanceProcAddr(long struct)

Unsafe version of vkGetInstanceProcAddr.

public static void
nvkGetInstanceProcAddr(long struct, long value)

Unsafe version of vkGetInstanceProcAddr.

public static long
public static void
public static long
public static void
public static long
public static void
public static long
nvkMapMemory(long struct)

Unsafe version of vkMapMemory.

public static void
nvkMapMemory(long struct, long value)

Unsafe version of vkMapMemory.

public static long
nvkQueueSubmit(long struct)

Unsafe version of vkQueueSubmit.

public static void
nvkQueueSubmit(long struct, long value)

Unsafe version of vkQueueSubmit.

public static long
nvkQueueWaitIdle(long struct)

Unsafe version of vkQueueWaitIdle.

public static void
nvkQueueWaitIdle(long struct, long value)

Unsafe version of vkQueueWaitIdle.

public static long
nvkUnmapMemory(long struct)

Unsafe version of vkUnmapMemory.

public static void
nvkUnmapMemory(long struct, long value)

Unsafe version of vkUnmapMemory.

public static long
nvkWaitForFences(long struct)

Unsafe version of vkWaitForFences.

public static void
nvkWaitForFences(long struct, long value)

Unsafe version of vkWaitForFences.

public ktxVulkanFunctions
set(long vkGetInstanceProcAddr, long vkGetDeviceProcAddr, long vkAllocateCommandBuffers, long vkAllocateMemory, long vkBeginCommandBuffer, long vkBindBufferMemory, long vkBindImageMemory, long vkCmdBlitImage, long vkCmdCopyBufferToImage, long vkCmdPipelineBarrier, long vkCreateImage, long vkDestroyImage, long vkCreateBuffer, long vkDestroyBuffer, long vkCreateFence, long vkDestroyFence, long vkEndCommandBuffer, long vkFreeCommandBuffers, long vkFreeMemory, long vkGetBufferMemoryRequirements, long vkGetImageMemoryRequirements, long vkGetImageSubresourceLayout, long vkGetPhysicalDeviceImageFormatProperties, long vkGetPhysicalDeviceFormatProperties, long vkGetPhysicalDeviceMemoryProperties, long vkMapMemory, long vkQueueSubmit, long vkQueueWaitIdle, long vkUnmapMemory, long vkWaitForFences)

Initializes this struct with the specified values.

public ktxVulkanFunctions

Returns:

this struct
set
(ktxVulkanFunctions
the source struct
src
)

Copies the specified struct data to this struct.

public ktxVulkanFunctions
set(VkInstance
a Vulkan instance
instance
,
VkDevice
a Vulkan device
device
)

Helper method that populates this struct with required Vulkan function pointers from the specified Vulkan instance and device.

public int
sizeof()

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

Returns sizeof(struct).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

public long

Returns:

the value of the vkAllocateCommandBuffers field.
vkAllocateCommandBuffers
()

public ktxVulkanFunctions
vkAllocateCommandBuffers(long value)

Sets the specified value to the vkAllocateCommandBuffers field.

public long

Returns:

the value of the vkAllocateMemory field.
vkAllocateMemory
()

public ktxVulkanFunctions
vkAllocateMemory(long value)

Sets the specified value to the vkAllocateMemory field.

public long

Returns:

the value of the vkBeginCommandBuffer field.
vkBeginCommandBuffer
()

public ktxVulkanFunctions
vkBeginCommandBuffer(long value)

Sets the specified value to the vkBeginCommandBuffer field.

public long

Returns:

the value of the vkBindBufferMemory field.
vkBindBufferMemory
()

public ktxVulkanFunctions
vkBindBufferMemory(long value)

Sets the specified value to the vkBindBufferMemory field.

public long

Returns:

the value of the vkBindImageMemory field.
vkBindImageMemory
()

public ktxVulkanFunctions
vkBindImageMemory(long value)

Sets the specified value to the vkBindImageMemory field.

public long

Returns:

the value of the vkCmdBlitImage field.
vkCmdBlitImage
()

public ktxVulkanFunctions
vkCmdBlitImage(long value)

Sets the specified value to the vkCmdBlitImage field.

public long

Returns:

the value of the vkCmdCopyBufferToImage field.
vkCmdCopyBufferToImage
()

public ktxVulkanFunctions
vkCmdCopyBufferToImage(long value)

Sets the specified value to the vkCmdCopyBufferToImage field.

public long

Returns:

the value of the vkCmdPipelineBarrier field.
vkCmdPipelineBarrier
()

public ktxVulkanFunctions
vkCmdPipelineBarrier(long value)

Sets the specified value to the vkCmdPipelineBarrier field.

public long

Returns:

the value of the vkCreateBuffer field.
vkCreateBuffer
()

public ktxVulkanFunctions
vkCreateBuffer(long value)

Sets the specified value to the vkCreateBuffer field.

public long

Returns:

the value of the vkCreateFence field.
vkCreateFence
()

public ktxVulkanFunctions
vkCreateFence(long value)

Sets the specified value to the vkCreateFence field.

public long

Returns:

the value of the vkCreateImage field.
vkCreateImage
()

public ktxVulkanFunctions
vkCreateImage(long value)

Sets the specified value to the vkCreateImage field.

public long

Returns:

the value of the vkDestroyBuffer field.
vkDestroyBuffer
()

public ktxVulkanFunctions
vkDestroyBuffer(long value)

Sets the specified value to the vkDestroyBuffer field.

public long

Returns:

the value of the vkDestroyFence field.
vkDestroyFence
()

public ktxVulkanFunctions
vkDestroyFence(long value)

Sets the specified value to the vkDestroyFence field.

public long

Returns:

the value of the vkDestroyImage field.
vkDestroyImage
()

public ktxVulkanFunctions
vkDestroyImage(long value)

Sets the specified value to the vkDestroyImage field.

public long

Returns:

the value of the vkEndCommandBuffer field.
vkEndCommandBuffer
()

public ktxVulkanFunctions
vkEndCommandBuffer(long value)

Sets the specified value to the vkEndCommandBuffer field.

public long

Returns:

the value of the vkFreeCommandBuffers field.
vkFreeCommandBuffers
()

public ktxVulkanFunctions
vkFreeCommandBuffers(long value)

Sets the specified value to the vkFreeCommandBuffers field.

public long

Returns:

the value of the vkFreeMemory field.
vkFreeMemory
()

public ktxVulkanFunctions
vkFreeMemory(long value)

Sets the specified value to the vkFreeMemory field.

public long

Returns:

the value of the vkGetBufferMemoryRequirements field.
vkGetBufferMemoryRequirements
()

public ktxVulkanFunctions
vkGetBufferMemoryRequirements(long value)

Sets the specified value to the vkGetBufferMemoryRequirements field.

public long

Returns:

the value of the vkGetDeviceProcAddr field.
vkGetDeviceProcAddr
()

public ktxVulkanFunctions
vkGetDeviceProcAddr(long value)

Sets the specified value to the vkGetDeviceProcAddr field.

public long

Returns:

the value of the vkGetImageMemoryRequirements field.
vkGetImageMemoryRequirements
()

public ktxVulkanFunctions
vkGetImageMemoryRequirements(long value)

Sets the specified value to the vkGetImageMemoryRequirements field.

public long

Returns:

the value of the vkGetImageSubresourceLayout field.
vkGetImageSubresourceLayout
()

public ktxVulkanFunctions
vkGetImageSubresourceLayout(long value)

Sets the specified value to the vkGetImageSubresourceLayout field.

public long
vkGetInstanceProcAddr()

these are functions pointers we need to perform our vulkan duties

public ktxVulkanFunctions
vkGetInstanceProcAddr(long value)

Sets the specified value to the vkGetInstanceProcAddr field.

public long

Returns:

the value of the vkGetPhysicalDeviceFormatProperties field.
vkGetPhysicalDeviceFormatProperties
()

public ktxVulkanFunctions
vkGetPhysicalDeviceFormatProperties(long value)

Sets the specified value to the vkGetPhysicalDeviceFormatProperties field.

public long

Returns:

the value of the vkGetPhysicalDeviceImageFormatProperties field.
vkGetPhysicalDeviceImageFormatProperties
()

public ktxVulkanFunctions
vkGetPhysicalDeviceImageFormatProperties(long value)

Sets the specified value to the vkGetPhysicalDeviceImageFormatProperties field.

public long

Returns:

the value of the vkGetPhysicalDeviceMemoryProperties field.
vkGetPhysicalDeviceMemoryProperties
()

public ktxVulkanFunctions
vkGetPhysicalDeviceMemoryProperties(long value)

Sets the specified value to the vkGetPhysicalDeviceMemoryProperties field.

public long

Returns:

the value of the vkMapMemory field.
vkMapMemory
()

public ktxVulkanFunctions
vkMapMemory(long value)

Sets the specified value to the vkMapMemory field.

public long

Returns:

the value of the vkQueueSubmit field.
vkQueueSubmit
()

public ktxVulkanFunctions
vkQueueSubmit(long value)

Sets the specified value to the vkQueueSubmit field.

public long

Returns:

the value of the vkQueueWaitIdle field.
vkQueueWaitIdle
()

public ktxVulkanFunctions
vkQueueWaitIdle(long value)

Sets the specified value to the vkQueueWaitIdle field.

public long

Returns:

the value of the vkUnmapMemory field.
vkUnmapMemory
()

public ktxVulkanFunctions
vkUnmapMemory(long value)

Sets the specified value to the vkUnmapMemory field.

public long

Returns:

the value of the vkWaitForFences field.
vkWaitForFences
()

public ktxVulkanFunctions
vkWaitForFences(long value)

Sets the specified value to the vkWaitForFences field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate