VkPipelineExecutablePropertiesKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkPipelineExecutablePropertiesKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing a pipeline executable.
Description

The stages field may be zero or it may contain one or more bits describing the stages principally used to compile this pipeline. Not all implementations have a 1:1 mapping between shader stages and pipeline executables and some implementations may reduce a given shader stage to fixed function hardware programming such that no executable is available. No guarantees are provided about the mapping between shader stages and pipeline executables and stages should be considered a best effort hint. Because the application cannot rely on the stages field to provide an exact description, name and description provide a human readable name and description which more accurately describes the given pipeline executable.

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

GetPipelineExecutablePropertiesKHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- stages – a bitmask of VkShaderStageFlagBits indicating which shader stages (if any) were principally used as inputs to compile this pipeline executable.
- 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 executable.
- 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 executable.
- subgroupSize – the subgroup size with which this executable is dispatched.
Layout
```
 struct VkPipelineExecutablePropertiesKHR {
     VkStructureType sType;
     void * pNext;
     VkShaderStageFlags stages;
     char name[VK_MAX_DESCRIPTION_SIZE];
     char description[VK_MAX_DESCRIPTION_SIZE];
     uint32_t subgroupSize;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkPipelineExecutablePropertiesKHR.Buffer
An array of VkPipelineExecutablePropertiesKHR 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`	`VkPipelineExecutablePropertiesKHR.Buffer` An array of `VkPipelineExecutablePropertiesKHR` structs.

Field Summary

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

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

STAGES

NAME

DESCRIPTION

SUBGROUPSIZE

Constructor Detail

VkPipelineExecutablePropertiesKHR

Method Detail

sizeof

sType

pNext

stages

name

nameString

description

descriptionString

subgroupSize

sType

pNext

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nstages

nname

nnameString

ndescription

ndescriptionString

nsubgroupSize

nsType

npNext