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

public Class ShadercIncludeResult

extends Struct<ShadercIncludeResult>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct shaderc_include_result
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
An include result.

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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
ShadercIncludeResult.Buffer

An array of ShadercIncludeResult structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CONTENT

The struct member offsets.

public static final int
CONTENT_LENGTH

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SOURCE_NAME

The struct member offsets.

public static final int
SOURCE_NAME_LENGTH

The struct member offsets.

public static final int
USER_DATA

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
ShadercIncludeResult(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static ShadercIncludeResult
calloc()

Returns a new ShadercIncludeResult instance allocated with memCalloc.

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

Returns a new ShadercIncludeResult.Buffer instance allocated with memCalloc.

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

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

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

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

public static ShadercIncludeResult
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static ShadercIncludeResult
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ShadercIncludeResult.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static ShadercIncludeResult.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public ByteBuffer
content()

the text contents of the source file in the normal case.

public ShadercIncludeResult
content(ByteBuffer value)

Sets the address of the specified encoded string to the content field.

public long

Returns:

the value of the content_length field.
content_length()

public String
contentString()

the text contents of the source file in the normal case.

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

Returns a new ShadercIncludeResult instance allocated with BufferUtils.

public static ShadercIncludeResult
create(long address)

Returns a new ShadercIncludeResult instance for the specified memory address.

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

Returns a new ShadercIncludeResult.Buffer instance allocated with BufferUtils.

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

Create a ShadercIncludeResult.Buffer instance at the specified memory.

public static ShadercIncludeResult
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static ShadercIncludeResult
malloc()

Returns a new ShadercIncludeResult instance allocated with memAlloc.

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

Returns a new ShadercIncludeResult.Buffer instance allocated with memAlloc.

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

Returns a new ShadercIncludeResult instance allocated on the specified MemoryStack.

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

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

public static ShadercIncludeResult
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static ShadercIncludeResult
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ShadercIncludeResult.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static ShadercIncludeResult.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ByteBuffer
ncontent(long struct)

Unsafe version of content.

public static void
ncontent(long struct, ByteBuffer value)

Unsafe version of content.

public static long
ncontent_length(long struct)

Unsafe version of content_length.

public static void
ncontent_length(long struct, long value)

Sets the specified value to the content_length field of the specified struct.

public static String
ncontentString(long struct)

Unsafe version of contentString.

public static ByteBuffer
nsource_name(long struct)

Unsafe version of source_name.

public static void
nsource_name(long struct, ByteBuffer value)

Unsafe version of source_name.

public static long
nsource_name_length(long struct)

Unsafe version of source_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.

public static String
nsource_nameString(long struct)

Unsafe version of source_nameString.

public static long
nuser_data(long struct)

Unsafe version of user_data.

public static void
nuser_data(long struct, long value)

Unsafe version of user_data.

public ShadercIncludeResult
set(ByteBuffer source_name, ByteBuffer content, long user_data)

Initializes this struct with the specified values.

public ShadercIncludeResult

Returns:

this struct
set(ShadercIncludeResult
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public ByteBuffer
source_name()

the name of the source file.

public ShadercIncludeResult
source_name(ByteBuffer value)

Sets the address of the specified encoded string to the source_name field.

public long

Returns:

the value of the source_name_length field.
source_name_length()

public String
source_nameString()

the name of the source file.

public long
user_data()

user data to be passed along with this request

public ShadercIncludeResult
user_data(long value)

Sets the specified value to the user_data field.

public static void
validate(long
the struct to validate
struct)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

CONTENTback to summary
public static final int CONTENT

The struct member offsets.

CONTENT_LENGTHback to summary
public static final int CONTENT_LENGTH

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SOURCE_NAMEback to summary
public static final int SOURCE_NAME

The struct member offsets.

SOURCE_NAME_LENGTHback to summary
public static final int SOURCE_NAME_LENGTH

The struct member offsets.

USER_DATAback to summary
public static final int USER_DATA

The struct member offsets.

Constructor Detail

ShadercIncludeResultback to summary
protected ShadercIncludeResult(long address, ByteBuffer container)
ShadercIncludeResultback to summary
public ShadercIncludeResult(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

callocback to summary
public static ShadercIncludeResult calloc()

Returns a new ShadercIncludeResult instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static ShadercIncludeResult.Buffer calloc(int capacity)

Returns a new ShadercIncludeResult.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static ShadercIncludeResult calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static ShadercIncludeResult.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static ShadercIncludeResult callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static ShadercIncludeResult callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static ShadercIncludeResult.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static ShadercIncludeResult.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
contentback to summary
public ByteBuffer content()

the text contents of the source file in the normal case. For a failed inclusion, this contains the error message.

Annotations
@NativeType:char const *
contentback to summary
public ShadercIncludeResult content(ByteBuffer value)

Sets the address of the specified encoded string to the content field.

content_lengthback to summary
public long content_length()
Returns:long

the value of the content_length field.

Annotations
@NativeType:size_t
contentStringback to summary
public String contentString()

the text contents of the source file in the normal case. For a failed inclusion, this contains the error message.

Annotations
@NativeType:char const *
createback to summary
protected ShadercIncludeResult create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static ShadercIncludeResult create()

Returns a new ShadercIncludeResult instance allocated with BufferUtils.

createback to summary
public static ShadercIncludeResult create(long address)

Returns a new ShadercIncludeResult instance for the specified memory address.

createback to summary
public static ShadercIncludeResult.Buffer create(int capacity)

Returns a new ShadercIncludeResult.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static ShadercIncludeResult.Buffer create(long address, int capacity)

Create a ShadercIncludeResult.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static ShadercIncludeResult createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static ShadercIncludeResult.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static ShadercIncludeResult malloc()

Returns a new ShadercIncludeResult instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static ShadercIncludeResult.Buffer malloc(int capacity)

Returns a new ShadercIncludeResult.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static ShadercIncludeResult malloc(MemoryStack stack)

Returns a new ShadercIncludeResult instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static ShadercIncludeResult.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static ShadercIncludeResult mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static ShadercIncludeResult mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static ShadercIncludeResult.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static ShadercIncludeResult.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
ncontentback to summary
public static ByteBuffer ncontent(long struct)

Unsafe version of content.

ncontentback to summary
public static void ncontent(long struct, ByteBuffer value)

Unsafe version of content.

ncontent_lengthback to summary
public static long ncontent_length(long struct)

Unsafe version of content_length.

ncontent_lengthback to summary
public static void ncontent_length(long struct, long value)

Sets the specified value to the content_length field of the specified struct.

ncontentStringback to summary
public static String ncontentString(long struct)

Unsafe version of contentString.

nsource_nameback to summary
public static ByteBuffer nsource_name(long struct)

Unsafe version of source_name.

nsource_nameback to summary
public static void nsource_name(long struct, ByteBuffer value)

Unsafe version of source_name.

nsource_name_lengthback to summary
public static long nsource_name_length(long struct)

Unsafe version of source_name_length.

nsource_name_lengthback to summary
public static void nsource_name_length(long struct, long value)

Sets the specified value to the source_name_length field of the specified struct.

nsource_nameStringback to summary
public static String nsource_nameString(long struct)

Unsafe version of source_nameString.

nuser_databack to summary
public static long nuser_data(long struct)

Unsafe version of user_data.

nuser_databack to summary
public static void nuser_data(long struct, long value)

Unsafe version of user_data.

setback to summary
public ShadercIncludeResult set(ByteBuffer source_name, ByteBuffer content, long user_data)

Initializes this struct with the specified values.

setback to summary
public ShadercIncludeResult set(ShadercIncludeResult src)

Copies the specified struct data to this struct.

Parameters
src:ShadercIncludeResult

the source struct

Returns:ShadercIncludeResult

this struct

sizeofback to summary
public int sizeof()

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

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
source_nameback to summary
public ByteBuffer 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.

Annotations
@NativeType:char const *
source_nameback to summary
public ShadercIncludeResult source_name(ByteBuffer value)

Sets the address of the specified encoded string to the source_name field.

source_name_lengthback to summary
public long source_name_length()
Returns:long

the value of the source_name_length field.

Annotations
@NativeType:size_t
source_nameStringback to summary
public String source_nameString()

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.

Annotations
@NativeType:char const *
user_databack to summary
public long user_data()

user data to be passed along with this request

Annotations
@NativeType:void *
user_databack to summary
public ShadercIncludeResult user_data(long value)

Sets the specified value to the user_data field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.util.shaderc back to summary

public Class ShadercIncludeResult.Buffer

extends StructBuffer<ShadercIncludeResult, ShadercIncludeResult.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of ShadercIncludeResult structs.

Field Summary

Modifier and TypeField and Description
private static final ShadercIncludeResult
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new ShadercIncludeResult.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the ShadercIncludeResult#content field.
content()

public ShadercIncludeResult.Buffer
content(ByteBuffer value)

Sets the address of the specified encoded string to the ShadercIncludeResult#content field.

public long

Returns:

the value of the content_length field.
content_length()

public String

Returns:

the null-terminated string pointed to by the ShadercIncludeResult#content field.
contentString()

protected ShadercIncludeResult
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

protected ShadercIncludeResult.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the ShadercIncludeResult#source_name field.
source_name()

public ShadercIncludeResult.Buffer
source_name(ByteBuffer value)

Sets the address of the specified encoded string to the ShadercIncludeResult#source_name field.

public long

Returns:

the value of the source_name_length field.
source_name_length()

public String

Returns:

the null-terminated string pointed to by the ShadercIncludeResult#source_name field.
source_nameString()

public long

Returns:

the value of the ShadercIncludeResult#user_data field.
user_data()

public ShadercIncludeResult.Buffer
user_data(long value)

Sets the specified value to the ShadercIncludeResult#user_data field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final ShadercIncludeResult ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new ShadercIncludeResult.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by ShadercIncludeResult#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

contentback to summary
public ByteBuffer content()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the ShadercIncludeResult#content field.

Annotations
@NativeType:char const *
contentback to summary
public ShadercIncludeResult.Buffer content(ByteBuffer value)

Sets the address of the specified encoded string to the ShadercIncludeResult#content field.

content_lengthback to summary
public long content_length()
Returns:long

the value of the content_length field.

Annotations
@NativeType:size_t
contentStringback to summary
public String contentString()
Returns:String

the null-terminated string pointed to by the ShadercIncludeResult#content field.

Annotations
@NativeType:char const *
getElementFactoryback to summary
protected ShadercIncludeResult getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
selfback to summary
protected ShadercIncludeResult.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
source_nameback to summary
public ByteBuffer source_name()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the ShadercIncludeResult#source_name field.

Annotations
@NativeType:char const *
source_nameback to summary
public ShadercIncludeResult.Buffer source_name(ByteBuffer value)

Sets the address of the specified encoded string to the ShadercIncludeResult#source_name field.

source_name_lengthback to summary
public long source_name_length()
Returns:long

the value of the source_name_length field.

Annotations
@NativeType:size_t
source_nameStringback to summary
public String source_nameString()
Returns:String

the null-terminated string pointed to by the ShadercIncludeResult#source_name field.

Annotations
@NativeType:char const *
user_databack to summary
public long user_data()
Returns:long

the value of the ShadercIncludeResult#user_data field.

Annotations
@NativeType:void *
user_databack to summary
public ShadercIncludeResult.Buffer user_data(long value)

Sets the specified value to the ShadercIncludeResult#user_data field.