VkPipelineExecutableInternalRepresentationKHR (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkPipelineExecutableInternalRepresentationKHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkPipelineExecutableInternalRepresentationKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing the textual form of a pipeline executable internal representation.
Description

If pData is NULL, then the size, in bytes, of the internal representation data is returned in dataSize. Otherwise, dataSize must be the size of the buffer, in bytes, pointed to by pData and on return dataSize is overwritten with the number of bytes of data actually written to pData including any trailing null character. If dataSize is less than the size, in bytes, of the internal representation data, at most dataSize bytes of data will be written to pData and vkGetPipelineExecutableInternalRepresentationsKHR will return INCOMPLETE. If isText is TRUE and pData is not NULL and dataSize is not zero, the last byte written to pData will be a null character.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHR
- pNext must be NULL
See Also

GetPipelineExecutableInternalRepresentationsKHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- name[VK_MAX_DESCRIPTION_SIZE] – an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a short human readable name for this internal representation.
- description[VK_MAX_DESCRIPTION_SIZE] – an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a human readable description for this internal representation.
- isText – specifies whether the returned data is text or opaque data. If isText is TRUE then the data returned in pData is text and is guaranteed to be a null-terminated UTF-8 string.
- dataSize – an integer related to the size, in bytes, of the internal representation data, as described below.
- pData – either NULL or a pointer to an block of data into which the implementation will write the textual form of the internal representation.
Layout
```
 struct VkPipelineExecutableInternalRepresentationKHR {
     VkStructureType sType;
     void * pNext;
     char name[VK_MAX_DESCRIPTION_SIZE];
     char description[VK_MAX_DESCRIPTION_SIZE];
     VkBool32 isText;
     size_t dataSize;
     void * pData;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkPipelineExecutableInternalRepresentationKHR.Buffer` An array of `VkPipelineExecutableInternalRepresentationKHR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DATASIZE` The struct member offsets.
`static int`	`DESCRIPTION` The struct member offsets.
`static int`	`ISTEXT` The struct member offsets.
`static int`	`NAME` The struct member offsets.
`static int`	`PDATA` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.

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

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkPipelineExecutableInternalRepresentationKHR`	`calloc()` Returns a new `VkPipelineExecutableInternalRepresentationKHR` instance allocated with `memCalloc`.
`static VkPipelineExecutableInternalRepresentationKHR.Buffer`	`calloc(int capacity)` Returns a new `VkPipelineExecutableInternalRepresentationKHR.Buffer` instance allocated with `memCalloc`.
`static VkPipelineExecutableInternalRepresentationKHR`	`callocStack()` Returns a new `VkPipelineExecutableInternalRepresentationKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineExecutableInternalRepresentationKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkPipelineExecutableInternalRepresentationKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineExecutableInternalRepresentationKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineExecutableInternalRepresentationKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineExecutableInternalRepresentationKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineExecutableInternalRepresentationKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineExecutableInternalRepresentationKHR`	`create()` Returns a new `VkPipelineExecutableInternalRepresentationKHR` instance allocated with `BufferUtils`.
`static VkPipelineExecutableInternalRepresentationKHR.Buffer`	`create(int capacity)` Returns a new `VkPipelineExecutableInternalRepresentationKHR.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineExecutableInternalRepresentationKHR`	`create(long address)` Returns a new `VkPipelineExecutableInternalRepresentationKHR` instance for the specified memory address.
`static VkPipelineExecutableInternalRepresentationKHR.Buffer`	`create(long address, int capacity)` Create a `VkPipelineExecutableInternalRepresentationKHR.Buffer` instance at the specified memory.
`static VkPipelineExecutableInternalRepresentationKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineExecutableInternalRepresentationKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`dataSize()` Returns the value of the `dataSize` field.
`java.nio.ByteBuffer`	`description()` Returns a `ByteBuffer` view of the `description` field.
`java.lang.String`	`descriptionString()` Decodes the null-terminated string stored in the `description` field.
`boolean`	`isText()` Returns the value of the `isText` field.
`static VkPipelineExecutableInternalRepresentationKHR`	`malloc()` Returns a new `VkPipelineExecutableInternalRepresentationKHR` instance allocated with `memAlloc`.
`static VkPipelineExecutableInternalRepresentationKHR.Buffer`	`malloc(int capacity)` Returns a new `VkPipelineExecutableInternalRepresentationKHR.Buffer` instance allocated with `memAlloc`.
`static VkPipelineExecutableInternalRepresentationKHR`	`mallocStack()` Returns a new `VkPipelineExecutableInternalRepresentationKHR` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineExecutableInternalRepresentationKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkPipelineExecutableInternalRepresentationKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineExecutableInternalRepresentationKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineExecutableInternalRepresentationKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineExecutableInternalRepresentationKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineExecutableInternalRepresentationKHR` instance allocated on the specified `MemoryStack`.
`java.nio.ByteBuffer`	`name()` Returns a `ByteBuffer` view of the `name` field.
`java.lang.String`	`nameString()` Decodes the null-terminated string stored in the `name` field.
`static long`	`ndataSize(long struct)` Unsafe version of `dataSize()`.
`static java.nio.ByteBuffer`	`ndescription(long struct)` Unsafe version of `description()`.
`static java.lang.String`	`ndescriptionString(long struct)` Unsafe version of `descriptionString()`.
`static int`	`nisText(long struct)` Unsafe version of `isText()`.
`static java.nio.ByteBuffer`	`nname(long struct)` Unsafe version of `name()`.
`static java.lang.String`	`nnameString(long struct)` Unsafe version of `nameString()`.
`static java.nio.ByteBuffer`	`npData(long struct)` Unsafe version of `pData`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`java.nio.ByteBuffer`	`pData()` Returns a `ByteBuffer` view of the data pointed to by the `pData` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPipelineExecutableInternalRepresentationKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkPipelineExecutableInternalRepresentationKHR`	`set(int sType, long pNext)` Initializes this struct with the specified values.
`VkPipelineExecutableInternalRepresentationKHR`	`set(VkPipelineExecutableInternalRepresentationKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkPipelineExecutableInternalRepresentationKHR`	`sType(int value)` Sets the specified value to the `sType` field.

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

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

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - NAME
```
public static final int NAME
```
    The struct member offsets.
  - DESCRIPTION
```
public static final int DESCRIPTION
```
    The struct member offsets.
  - ISTEXT
```
public static final int ISTEXT
```
    The struct member offsets.
  - DATASIZE
```
public static final int DATASIZE
```
    The struct member offsets.
  - PDATA
```
public static final int PDATA
```
    The struct member offsets.
- Constructor Detail
  - VkPipelineExecutableInternalRepresentationKHR
```
public VkPipelineExecutableInternalRepresentationKHR(java.nio.ByteBuffer container)
```
    Creates a VkPipelineExecutableInternalRepresentationKHR 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
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - name
```
public java.nio.ByteBuffer name()
```
    Returns a ByteBuffer view of the name field.
  - nameString
```
public java.lang.String nameString()
```
    Decodes the null-terminated string stored in the name field.
  - description
```
public java.nio.ByteBuffer description()
```
    Returns a ByteBuffer view of the description field.
  - descriptionString
```
public java.lang.String descriptionString()
```
    Decodes the null-terminated string stored in the description field.
  - isText
```
public boolean isText()
```
    Returns the value of the isText field.
  - dataSize
```
public long dataSize()
```
    Returns the value of the dataSize field.
  - pData
```
@Nullable
public java.nio.ByteBuffer pData()
```
    Returns a ByteBuffer view of the data pointed to by the pData field.
  - sType
```
public VkPipelineExecutableInternalRepresentationKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkPipelineExecutableInternalRepresentationKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - set
```
public VkPipelineExecutableInternalRepresentationKHR set(int sType,
                                                         long pNext)
```
    Initializes this struct with the specified values.
  - set
```
public VkPipelineExecutableInternalRepresentationKHR set(VkPipelineExecutableInternalRepresentationKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkPipelineExecutableInternalRepresentationKHR malloc()
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPipelineExecutableInternalRepresentationKHR calloc()
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPipelineExecutableInternalRepresentationKHR create()
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR instance allocated with BufferUtils.
  - create
```
public static VkPipelineExecutableInternalRepresentationKHR create(long address)
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkPipelineExecutableInternalRepresentationKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPipelineExecutableInternalRepresentationKHR.Buffer malloc(int capacity)
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPipelineExecutableInternalRepresentationKHR.Buffer calloc(int capacity)
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineExecutableInternalRepresentationKHR.Buffer create(int capacity)
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineExecutableInternalRepresentationKHR.Buffer create(long address,
                                                                          int capacity)
```
    Create a VkPipelineExecutableInternalRepresentationKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPipelineExecutableInternalRepresentationKHR.Buffer createSafe(long address,
                                                                                        int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkPipelineExecutableInternalRepresentationKHR mallocStack()
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPipelineExecutableInternalRepresentationKHR callocStack()
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPipelineExecutableInternalRepresentationKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPipelineExecutableInternalRepresentationKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkPipelineExecutableInternalRepresentationKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineExecutableInternalRepresentationKHR.Buffer callocStack(int capacity)
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPipelineExecutableInternalRepresentationKHR.Buffer mallocStack(int capacity,
                                                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineExecutableInternalRepresentationKHR.Buffer callocStack(int capacity,
                                                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineExecutableInternalRepresentationKHR.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
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nname
```
public static java.nio.ByteBuffer nname(long struct)
```
    Unsafe version of name().
  - nnameString
```
public static java.lang.String nnameString(long struct)
```
    Unsafe version of nameString().
  - ndescription
```
public static java.nio.ByteBuffer ndescription(long struct)
```
    Unsafe version of description().
  - ndescriptionString
```
public static java.lang.String ndescriptionString(long struct)
```
    Unsafe version of descriptionString().
  - nisText
```
public static int nisText(long struct)
```
    Unsafe version of isText().
  - ndataSize
```
public static long ndataSize(long struct)
```
    Unsafe version of dataSize().
  - npData
```
@Nullable
public static java.nio.ByteBuffer npData(long struct)
```
    Unsafe version of pData.
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.

Class VkPipelineExecutableInternalRepresentationKHR

Description

Valid Usage (Implicit)

See Also

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 class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

NAME

DESCRIPTION

ISTEXT

DATASIZE

PDATA

Constructor Detail

VkPipelineExecutableInternalRepresentationKHR

Method Detail

sizeof

sType

pNext

name

nameString

description

descriptionString

isText

dataSize

pData

sType

pNext

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nname

nnameString

ndescription

ndescriptionString

nisText

ndataSize

npData

nsType

npNext