ShadercIncludeResult (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.shaderc.ShadercIncludeResult

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class ShadercIncludeResult
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
An include result.
Member documentation
- source_name – the name of the source file.
  The name should be fully resolved in the sense that it should be a unique name in the context of the includer. For example, if the includer maps source names to files in a filesystem, then this name should be the absolute path of the file. For a failed inclusion, this string is empty.
- content – the text contents of the source file in the normal case. For a failed inclusion, this contains the error message.
- user_data – user data to be passed along with this request
Layout
```
 struct shaderc_include_result {
     char const * source_name;
     size_t source_name_length;
     char const * content;
     size_t content_length;
     void * user_data;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CONTENT` The struct member offsets.
`static int`	`CONTENT_LENGTH` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`SOURCE_NAME` The struct member offsets.
`static int`	`SOURCE_NAME_LENGTH` The struct member offsets.
`static int`	`USER_DATA` 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
`ShadercIncludeResult(java.nio.ByteBuffer container)` Creates a `ShadercIncludeResult` 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 ShadercIncludeResult`	`calloc()` Returns a new `ShadercIncludeResult` instance allocated with `memCalloc`.
`static ShadercIncludeResult.Buffer`	`calloc(int capacity)` Returns a new `ShadercIncludeResult.Buffer` instance allocated with `memCalloc`.
`static ShadercIncludeResult`	`callocStack()` Returns a new `ShadercIncludeResult` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ShadercIncludeResult.Buffer`	`callocStack(int capacity)` Returns a new `ShadercIncludeResult.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ShadercIncludeResult.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ShadercIncludeResult.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ShadercIncludeResult`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ShadercIncludeResult` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`long`	`content_length()` Returns the value of the `content_length` field.
`java.nio.ByteBuffer`	`content()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `content` field.
`ShadercIncludeResult`	`content(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `content` field.
`java.lang.String`	`contentString()` Decodes the null-terminated string pointed to by the `content` field.
`static ShadercIncludeResult`	`create()` Returns a new `ShadercIncludeResult` instance allocated with `BufferUtils`.
`static ShadercIncludeResult.Buffer`	`create(int capacity)` Returns a new `ShadercIncludeResult.Buffer` instance allocated with `BufferUtils`.
`static ShadercIncludeResult`	`create(long address)` Returns a new `ShadercIncludeResult` instance for the specified memory address.
`static ShadercIncludeResult.Buffer`	`create(long address, int capacity)` Create a `ShadercIncludeResult.Buffer` instance at the specified memory.
`static ShadercIncludeResult`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static ShadercIncludeResult.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static ShadercIncludeResult`	`malloc()` Returns a new `ShadercIncludeResult` instance allocated with `memAlloc`.
`static ShadercIncludeResult.Buffer`	`malloc(int capacity)` Returns a new `ShadercIncludeResult.Buffer` instance allocated with `memAlloc`.
`static ShadercIncludeResult`	`mallocStack()` Returns a new `ShadercIncludeResult` instance allocated on the thread-local `MemoryStack`.
`static ShadercIncludeResult.Buffer`	`mallocStack(int capacity)` Returns a new `ShadercIncludeResult.Buffer` instance allocated on the thread-local `MemoryStack`.
`static ShadercIncludeResult.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ShadercIncludeResult.Buffer` instance allocated on the specified `MemoryStack`.
`static ShadercIncludeResult`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ShadercIncludeResult` instance allocated on the specified `MemoryStack`.
`static long`	`ncontent_length(long struct)` Unsafe version of `content_length()`.
`static void`	`ncontent_length(long struct, long value)` Sets the specified value to the `content_length` field of the specified `struct`.
`static java.nio.ByteBuffer`	`ncontent(long struct)` Unsafe version of `content()`.
`static void`	`ncontent(long struct, java.nio.ByteBuffer value)` Unsafe version of `content`.
`static java.lang.String`	`ncontentString(long struct)` Unsafe version of `contentString()`.
`static long`	`nsource_name_length(long struct)` Unsafe version of `source_name_length()`.
`static void`	`nsource_name_length(long struct, long value)` Sets the specified value to the `source_name_length` field of the specified `struct`.
`static java.nio.ByteBuffer`	`nsource_name(long struct)` Unsafe version of `source_name()`.
`static void`	`nsource_name(long struct, java.nio.ByteBuffer value)` Unsafe version of `source_name`.
`static java.lang.String`	`nsource_nameString(long struct)` Unsafe version of `source_nameString()`.
`static long`	`nuser_data(long struct)` Unsafe version of `user_data()`.
`static void`	`nuser_data(long struct, long value)` Unsafe version of `user_data`.
`ShadercIncludeResult`	`set(java.nio.ByteBuffer source_name, java.nio.ByteBuffer content, long user_data)` Initializes this struct with the specified values.
`ShadercIncludeResult`	`set(ShadercIncludeResult src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`long`	`source_name_length()` Returns the value of the `source_name_length` field.
`java.nio.ByteBuffer`	`source_name()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `source_name` field.
`ShadercIncludeResult`	`source_name(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `source_name` field.
`java.lang.String`	`source_nameString()` Decodes the null-terminated string pointed to by the `source_name` field.
`long`	`user_data()` Returns the value of the `user_data` field.
`ShadercIncludeResult`	`user_data(long value)` Sets the specified value to the `user_data` field.
`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 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.
  - SOURCE_NAME
```
public static final int SOURCE_NAME
```
    The struct member offsets.
  - SOURCE_NAME_LENGTH
```
public static final int SOURCE_NAME_LENGTH
```
    The struct member offsets.
  - CONTENT
```
public static final int CONTENT
```
    The struct member offsets.
  - CONTENT_LENGTH
```
public static final int CONTENT_LENGTH
```
    The struct member offsets.
  - USER_DATA
```
public static final int USER_DATA
```
    The struct member offsets.
- Constructor Detail
  - ShadercIncludeResult
```
public ShadercIncludeResult(java.nio.ByteBuffer container)
```
    Creates a ShadercIncludeResult 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
  - source_name
```
public java.nio.ByteBuffer source_name()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the source_name field.
  - source_nameString
```
public java.lang.String source_nameString()
```
    Decodes the null-terminated string pointed to by the source_name field.
  - source_name_length
```
public long source_name_length()
```
    Returns the value of the source_name_length field.
  - content
```
public java.nio.ByteBuffer content()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the content field.
  - contentString
```
public java.lang.String contentString()
```
    Decodes the null-terminated string pointed to by the content field.
  - content_length
```
public long content_length()
```
    Returns the value of the content_length field.
  - user_data
```
public long user_data()
```
    Returns the value of the user_data field.
  - source_name
```
public ShadercIncludeResult source_name(java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the source_name field.
  - content
```
public ShadercIncludeResult content(java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the content field.
  - user_data
```
public ShadercIncludeResult user_data(long value)
```
    Sets the specified value to the user_data field.
  - set
```
public ShadercIncludeResult set(java.nio.ByteBuffer source_name,
                                java.nio.ByteBuffer content,
                                long user_data)
```
    Initializes this struct with the specified values.
  - set
```
public ShadercIncludeResult set(ShadercIncludeResult src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static ShadercIncludeResult malloc()
```
    Returns a new ShadercIncludeResult instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static ShadercIncludeResult calloc()
```
    Returns a new ShadercIncludeResult instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static ShadercIncludeResult create()
```
    Returns a new ShadercIncludeResult instance allocated with BufferUtils.
  - create
```
public static ShadercIncludeResult create(long address)
```
    Returns a new ShadercIncludeResult instance for the specified memory address.
  - createSafe
```
@Nullable
public static ShadercIncludeResult createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static ShadercIncludeResult.Buffer malloc(int capacity)
```
    Returns a new ShadercIncludeResult.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static ShadercIncludeResult.Buffer calloc(int capacity)
```
    Returns a new ShadercIncludeResult.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ShadercIncludeResult.Buffer create(int capacity)
```
    Returns a new ShadercIncludeResult.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ShadercIncludeResult.Buffer create(long address,
                                                 int capacity)
```
    Create a ShadercIncludeResult.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static ShadercIncludeResult.Buffer createSafe(long address,
                                                               int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static ShadercIncludeResult mallocStack()
```
    Returns a new ShadercIncludeResult instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static ShadercIncludeResult callocStack()
```
    Returns a new ShadercIncludeResult instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static ShadercIncludeResult mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ShadercIncludeResult instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static ShadercIncludeResult callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ShadercIncludeResult instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static ShadercIncludeResult.Buffer mallocStack(int capacity)
```
    Returns a new ShadercIncludeResult.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static ShadercIncludeResult.Buffer callocStack(int capacity)
```
    Returns a new ShadercIncludeResult.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static ShadercIncludeResult.Buffer mallocStack(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new ShadercIncludeResult.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static ShadercIncludeResult.Buffer callocStack(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new ShadercIncludeResult.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
  - nsource_name
```
public static java.nio.ByteBuffer nsource_name(long struct)
```
    Unsafe version of source_name().
  - nsource_nameString
```
public static java.lang.String nsource_nameString(long struct)
```
    Unsafe version of source_nameString().
  - nsource_name_length
```
public static long nsource_name_length(long struct)
```
    Unsafe version of source_name_length().
  - ncontent
```
public static java.nio.ByteBuffer ncontent(long struct)
```
    Unsafe version of content().
  - ncontentString
```
public static java.lang.String ncontentString(long struct)
```
    Unsafe version of contentString().
  - ncontent_length
```
public static long ncontent_length(long struct)
```
    Unsafe version of content_length().
  - nuser_data
```
public static long nuser_data(long struct)
```
    Unsafe version of user_data().
  - nsource_name
```
public static void nsource_name(long struct,
                                java.nio.ByteBuffer value)
```
    Unsafe version of source_name.
  - nsource_name_length
```
public static void nsource_name_length(long struct,
                                       long value)
```
    Sets the specified value to the source_name_length field of the specified struct.
  - ncontent
```
public static void ncontent(long struct,
                            java.nio.ByteBuffer value)
```
    Unsafe version of content.
  - ncontent_length
```
public static void ncontent_length(long struct,
                                   long value)
```
    Sets the specified value to the content_length field of the specified struct.
  - nuser_data
```
public static void nuser_data(long struct,
                              long value)
```
    Unsafe version of user_data.
  - 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 ShadercIncludeResult

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

SOURCE_NAME

SOURCE_NAME_LENGTH

CONTENT

CONTENT_LENGTH

USER_DATA

Constructor Detail

ShadercIncludeResult

Method Detail

sizeof

source_name

source_nameString

source_name_length

content

contentString

content_length

user_data

source_name

content

user_data

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsource_name

nsource_nameString

nsource_name_length

ncontent

ncontentString

ncontent_length

nuser_data

nsource_name

nsource_name_length

ncontent

ncontent_length

nuser_data

validate

validate