java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.openvr.VRVulkanTextureData

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VRVulkanTextureData
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Data required for passing Vulkan textures to Submit. Be sure to call ShutdownInternal before destroying these resources.

Please see https://github.com/ValveSoftware/openvr/wiki/Vulkan for Vulkan-specific documentation.

Member documentation

m_nImage – VkImage

Layout


 struct VRVulkanTextureData_t {
     uint64_t m_nImage;
     VkDevice_T * m_pDevice;
     VkPhysicalDevice_T * m_pPhysicalDevice;
     VkInstance_T * m_pInstance;
     VkQueue_T * m_pQueue;
     uint32_t m_nQueueFamilyIndex;
     uint32_t m_nWidth;
     uint32_t m_nHeight;
     uint32_t m_nFormat;
     uint32_t m_nSampleCount;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VRVulkanTextureData.Buffer
An array of VRVulkanTextureData structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`M_NFORMAT M_NHEIGHT M_NIMAGE M_NQUEUEFAMILYINDEX M_NSAMPLECOUNT M_NWIDTH M_PDEVICE M_PINSTANCE M_PPHYSICALDEVICE M_PQUEUE`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`VRVulkanTextureData(java.nio.ByteBuffer container)`	Creates a `VRVulkanTextureData` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VRVulkanTextureData`	`calloc()`	Returns a new `VRVulkanTextureData` instance allocated with `memCalloc`.
`static VRVulkanTextureData.Buffer`	`calloc(int capacity)`	Returns a new `VRVulkanTextureData.Buffer` instance allocated with `memCalloc`.
`static VRVulkanTextureData`	`callocStack()`	Returns a new `VRVulkanTextureData` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VRVulkanTextureData.Buffer`	`callocStack(int capacity)`	Returns a new `VRVulkanTextureData.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VRVulkanTextureData.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VRVulkanTextureData.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VRVulkanTextureData`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `VRVulkanTextureData` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VRVulkanTextureData`	`create()`	Returns a new `VRVulkanTextureData` instance allocated with `BufferUtils`.
`static VRVulkanTextureData.Buffer`	`create(int capacity)`	Returns a new `VRVulkanTextureData.Buffer` instance allocated with `BufferUtils`.
`static VRVulkanTextureData`	`create(long address)`	Returns a new `VRVulkanTextureData` instance for the specified memory address.
`static VRVulkanTextureData.Buffer`	`create(long address, int capacity)`	Create a `VRVulkanTextureData.Buffer` instance at the specified memory.
`static VRVulkanTextureData`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VRVulkanTextureData.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`m_nFormat()`	Returns the value of the `m_nFormat` field.
`VRVulkanTextureData`	`m_nFormat(int value)`	Sets the specified value to the `m_nFormat` field.
`int`	`m_nHeight()`	Returns the value of the `m_nHeight` field.
`VRVulkanTextureData`	`m_nHeight(int value)`	Sets the specified value to the `m_nHeight` field.
`long`	`m_nImage()`	Returns the value of the `m_nImage` field.
`VRVulkanTextureData`	`m_nImage(long value)`	Sets the specified value to the `m_nImage` field.
`int`	`m_nQueueFamilyIndex()`	Returns the value of the `m_nQueueFamilyIndex` field.
`VRVulkanTextureData`	`m_nQueueFamilyIndex(int value)`	Sets the specified value to the `m_nQueueFamilyIndex` field.
`int`	`m_nSampleCount()`	Returns the value of the `m_nSampleCount` field.
`VRVulkanTextureData`	`m_nSampleCount(int value)`	Sets the specified value to the `m_nSampleCount` field.
`int`	`m_nWidth()`	Returns the value of the `m_nWidth` field.
`VRVulkanTextureData`	`m_nWidth(int value)`	Sets the specified value to the `m_nWidth` field.
`long`	`m_pDevice()`	Returns the value of the `m_pDevice` field.
`VRVulkanTextureData`	`m_pDevice(long value)`	Sets the specified value to the `m_pDevice` field.
`long`	`m_pInstance()`	Returns the value of the `m_pInstance` field.
`VRVulkanTextureData`	`m_pInstance(long value)`	Sets the specified value to the `m_pInstance` field.
`long`	`m_pPhysicalDevice()`	Returns the value of the `m_pPhysicalDevice` field.
`VRVulkanTextureData`	`m_pPhysicalDevice(long value)`	Sets the specified value to the `m_pPhysicalDevice` field.
`long`	`m_pQueue()`	Returns the value of the `m_pQueue` field.
`VRVulkanTextureData`	`m_pQueue(long value)`	Sets the specified value to the `m_pQueue` field.
`static VRVulkanTextureData`	`malloc()`	Returns a new `VRVulkanTextureData` instance allocated with `memAlloc`.
`static VRVulkanTextureData.Buffer`	`malloc(int capacity)`	Returns a new `VRVulkanTextureData.Buffer` instance allocated with `memAlloc`.
`static VRVulkanTextureData`	`mallocStack()`	Returns a new `VRVulkanTextureData` instance allocated on the thread-local `MemoryStack`.
`static VRVulkanTextureData.Buffer`	`mallocStack(int capacity)`	Returns a new `VRVulkanTextureData.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VRVulkanTextureData.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VRVulkanTextureData.Buffer` instance allocated on the specified `MemoryStack`.
`static VRVulkanTextureData`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `VRVulkanTextureData` instance allocated on the specified `MemoryStack`.
`static int`	`nm_nFormat(long struct)`	Unsafe version of `m_nFormat()`.
`static void`	`nm_nFormat(long struct, int value)`	Unsafe version of `m_nFormat`.
`static int`	`nm_nHeight(long struct)`	Unsafe version of `m_nHeight()`.
`static void`	`nm_nHeight(long struct, int value)`	Unsafe version of `m_nHeight`.
`static long`	`nm_nImage(long struct)`	Unsafe version of `m_nImage()`.
`static void`	`nm_nImage(long struct, long value)`	Unsafe version of `m_nImage`.
`static int`	`nm_nQueueFamilyIndex(long struct)`	Unsafe version of `m_nQueueFamilyIndex()`.
`static void`	`nm_nQueueFamilyIndex(long struct, int value)`	Unsafe version of `m_nQueueFamilyIndex`.
`static int`	`nm_nSampleCount(long struct)`	Unsafe version of `m_nSampleCount()`.
`static void`	`nm_nSampleCount(long struct, int value)`	Unsafe version of `m_nSampleCount`.
`static int`	`nm_nWidth(long struct)`	Unsafe version of `m_nWidth()`.
`static void`	`nm_nWidth(long struct, int value)`	Unsafe version of `m_nWidth`.
`static long`	`nm_pDevice(long struct)`	Unsafe version of `m_pDevice()`.
`static void`	`nm_pDevice(long struct, long value)`	Unsafe version of `m_pDevice`.
`static long`	`nm_pInstance(long struct)`	Unsafe version of `m_pInstance()`.
`static void`	`nm_pInstance(long struct, long value)`	Unsafe version of `m_pInstance`.
`static long`	`nm_pPhysicalDevice(long struct)`	Unsafe version of `m_pPhysicalDevice()`.
`static void`	`nm_pPhysicalDevice(long struct, long value)`	Unsafe version of `m_pPhysicalDevice`.
`static long`	`nm_pQueue(long struct)`	Unsafe version of `m_pQueue()`.
`static void`	`nm_pQueue(long struct, long value)`	Unsafe version of `m_pQueue`.
`VRVulkanTextureData`	`set(long m_nImage, long m_pDevice, long m_pPhysicalDevice, long m_pInstance, long m_pQueue, int m_nQueueFamilyIndex, int m_nWidth, int m_nHeight, int m_nFormat, int m_nSampleCount)`	Initializes this struct with the specified values.
`VRVulkanTextureData`	`set(VRVulkanTextureData src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)`	Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - M_NIMAGE, M_PDEVICE, M_PPHYSICALDEVICE, M_PINSTANCE, M_PQUEUE, M_NQUEUEFAMILYINDEX, M_NWIDTH, M_NHEIGHT, M_NFORMAT, M_NSAMPLECOUNT
    
    The struct member offsets.
- Constructor Detail
  - VRVulkanTextureData
```
public VRVulkanTextureData(java.nio.ByteBuffer container)
```
    Creates a VRVulkanTextureData 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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - m_nImage
```
public long m_nImage()
```
    Returns the value of the m_nImage field.
  - m_pDevice
```
public long m_pDevice()
```
    Returns the value of the m_pDevice field.
  - m_pPhysicalDevice
```
public long m_pPhysicalDevice()
```
    Returns the value of the m_pPhysicalDevice field.
  - m_pInstance
```
public long m_pInstance()
```
    Returns the value of the m_pInstance field.
  - m_pQueue
```
public long m_pQueue()
```
    Returns the value of the m_pQueue field.
  - m_nQueueFamilyIndex
```
public int m_nQueueFamilyIndex()
```
    Returns the value of the m_nQueueFamilyIndex field.
  - m_nWidth
```
public int m_nWidth()
```
    Returns the value of the m_nWidth field.
  - m_nHeight
```
public int m_nHeight()
```
    Returns the value of the m_nHeight field.
  - m_nFormat
```
public int m_nFormat()
```
    Returns the value of the m_nFormat field.
  - m_nSampleCount
```
public int m_nSampleCount()
```
    Returns the value of the m_nSampleCount field.
  - m_nImage
```
public VRVulkanTextureData m_nImage(long value)
```
    Sets the specified value to the m_nImage field.
  - m_pDevice
```
public VRVulkanTextureData m_pDevice(long value)
```
    Sets the specified value to the m_pDevice field.
  - m_pPhysicalDevice
```
public VRVulkanTextureData m_pPhysicalDevice(long value)
```
    Sets the specified value to the m_pPhysicalDevice field.
  - m_pInstance
```
public VRVulkanTextureData m_pInstance(long value)
```
    Sets the specified value to the m_pInstance field.
  - m_pQueue
```
public VRVulkanTextureData m_pQueue(long value)
```
    Sets the specified value to the m_pQueue field.
  - m_nQueueFamilyIndex
```
public VRVulkanTextureData m_nQueueFamilyIndex(int value)
```
    Sets the specified value to the m_nQueueFamilyIndex field.
  - m_nWidth
```
public VRVulkanTextureData m_nWidth(int value)
```
    Sets the specified value to the m_nWidth field.
  - m_nHeight
```
public VRVulkanTextureData m_nHeight(int value)
```
    Sets the specified value to the m_nHeight field.
  - m_nFormat
```
public VRVulkanTextureData m_nFormat(int value)
```
    Sets the specified value to the m_nFormat field.
  - m_nSampleCount
```
public VRVulkanTextureData m_nSampleCount(int value)
```
    Sets the specified value to the m_nSampleCount field.
  - set
```
public VRVulkanTextureData set(long m_nImage,
                               long m_pDevice,
                               long m_pPhysicalDevice,
                               long m_pInstance,
                               long m_pQueue,
                               int m_nQueueFamilyIndex,
                               int m_nWidth,
                               int m_nHeight,
                               int m_nFormat,
                               int m_nSampleCount)
```
    Initializes this struct with the specified values.
  - set
```
public VRVulkanTextureData set(VRVulkanTextureData src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VRVulkanTextureData malloc()
```
    Returns a new VRVulkanTextureData instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VRVulkanTextureData calloc()
```
    Returns a new VRVulkanTextureData instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VRVulkanTextureData create()
```
    Returns a new VRVulkanTextureData instance allocated with BufferUtils.
  - create
```
public static VRVulkanTextureData create(long address)
```
    Returns a new VRVulkanTextureData instance for the specified memory address.
  - createSafe
```
@Nullable
public static VRVulkanTextureData createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VRVulkanTextureData.Buffer malloc(int capacity)
```
    Returns a new VRVulkanTextureData.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VRVulkanTextureData.Buffer calloc(int capacity)
```
    Returns a new VRVulkanTextureData.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VRVulkanTextureData.Buffer create(int capacity)
```
    Returns a new VRVulkanTextureData.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VRVulkanTextureData.Buffer create(long address,
                                                int capacity)
```
    Create a VRVulkanTextureData.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VRVulkanTextureData.Buffer createSafe(long address,
                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VRVulkanTextureData mallocStack()
```
    Returns a new VRVulkanTextureData instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VRVulkanTextureData callocStack()
```
    Returns a new VRVulkanTextureData instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VRVulkanTextureData mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VRVulkanTextureData instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VRVulkanTextureData callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VRVulkanTextureData instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VRVulkanTextureData.Buffer mallocStack(int capacity)
```
    Returns a new VRVulkanTextureData.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VRVulkanTextureData.Buffer callocStack(int capacity)
```
    Returns a new VRVulkanTextureData.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VRVulkanTextureData.Buffer mallocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VRVulkanTextureData.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VRVulkanTextureData.Buffer callocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VRVulkanTextureData.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nm_nImage
```
public static long nm_nImage(long struct)
```
    Unsafe version of m_nImage().
  - nm_pDevice
```
public static long nm_pDevice(long struct)
```
    Unsafe version of m_pDevice().
  - nm_pPhysicalDevice
```
public static long nm_pPhysicalDevice(long struct)
```
    Unsafe version of m_pPhysicalDevice().
  - nm_pInstance
```
public static long nm_pInstance(long struct)
```
    Unsafe version of m_pInstance().
  - nm_pQueue
```
public static long nm_pQueue(long struct)
```
    Unsafe version of m_pQueue().
  - nm_nQueueFamilyIndex
```
public static int nm_nQueueFamilyIndex(long struct)
```
    Unsafe version of m_nQueueFamilyIndex().
  - nm_nWidth
```
public static int nm_nWidth(long struct)
```
    Unsafe version of m_nWidth().
  - nm_nHeight
```
public static int nm_nHeight(long struct)
```
    Unsafe version of m_nHeight().
  - nm_nFormat
```
public static int nm_nFormat(long struct)
```
    Unsafe version of m_nFormat().
  - nm_nSampleCount
```
public static int nm_nSampleCount(long struct)
```
    Unsafe version of m_nSampleCount().
  - nm_nImage
```
public static void nm_nImage(long struct,
                             long value)
```
    Unsafe version of m_nImage.
  - nm_pDevice
```
public static void nm_pDevice(long struct,
                              long value)
```
    Unsafe version of m_pDevice.
  - nm_pPhysicalDevice
```
public static void nm_pPhysicalDevice(long struct,
                                      long value)
```
    Unsafe version of m_pPhysicalDevice.
  - nm_pInstance
```
public static void nm_pInstance(long struct,
                                long value)
```
    Unsafe version of m_pInstance.
  - nm_pQueue
```
public static void nm_pQueue(long struct,
                             long value)
```
    Unsafe version of m_pQueue.
  - nm_nQueueFamilyIndex
```
public static void nm_nQueueFamilyIndex(long struct,
                                        int value)
```
    Unsafe version of m_nQueueFamilyIndex.
  - nm_nWidth
```
public static void nm_nWidth(long struct,
                             int value)
```
    Unsafe version of m_nWidth.
  - nm_nHeight
```
public static void nm_nHeight(long struct,
                              int value)
```
    Unsafe version of m_nHeight.
  - nm_nFormat
```
public static void nm_nFormat(long struct,
                              int value)
```
    Unsafe version of m_nFormat.
  - nm_nSampleCount
```
public static void nm_nSampleCount(long struct,
                                   int value)
```
    Unsafe version of m_nSampleCount.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VRVulkanTextureData

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

M_NIMAGE, M_PDEVICE, M_PPHYSICALDEVICE, M_PINSTANCE, M_PQUEUE, M_NQUEUEFAMILYINDEX, M_NWIDTH, M_NHEIGHT, M_NFORMAT, M_NSAMPLECOUNT

Constructor Detail

VRVulkanTextureData

Method Detail

sizeof

m_nImage

m_pDevice

m_pPhysicalDevice

m_pInstance

m_pQueue

m_nQueueFamilyIndex

m_nWidth

m_nHeight

m_nFormat

m_nSampleCount

m_nImage

m_pDevice

m_pPhysicalDevice

m_pInstance

m_pQueue

m_nQueueFamilyIndex

m_nWidth

m_nHeight

m_nFormat

m_nSampleCount

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nm_nImage

nm_pDevice

nm_pPhysicalDevice

nm_pInstance

nm_pQueue

nm_nQueueFamilyIndex

nm_nWidth

nm_nHeight

nm_nFormat

nm_nSampleCount

nm_nImage

nm_pDevice

nm_pPhysicalDevice

nm_pInstance

nm_pQueue

nm_nQueueFamilyIndex

nm_nWidth

nm_nHeight

nm_nFormat