Package org.lwjgl.util.shaderc

Class ShadercIncludeResult

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<ShadercIncludeResult>

org.lwjgl.util.shaderc.ShadercIncludeResult

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class ShadercIncludeResult
extends Struct<ShadercIncludeResult>
implements NativeResource

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 Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShadercIncludeResult.Buffer	An array of ShadercIncludeResult structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CONTENT	The struct member offsets.
static final int	CONTENT_LENGTH	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SOURCE_NAME	The struct member offsets.
static final int	SOURCE_NAME_LENGTH	The struct member offsets.
static final 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	Description
ShadercIncludeResult(ByteBuffer container)	Creates a ShadercIncludeResult instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new ShadercIncludeResult.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ShadercIncludeResult	calloc(MemoryStack stack)	Returns a new ShadercIncludeResult instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ShadercIncludeResult	callocStack()	Deprecated.
static ShadercIncludeResult.Buffer	callocStack(int capacity)	Deprecated.
static ShadercIncludeResult.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static ShadercIncludeResult	callocStack(MemoryStack stack)	Deprecated.
ByteBuffer	content()	the text contents of the source file in the normal case.
ShadercIncludeResult	content(ByteBuffer value)	Sets the address of the specified encoded string to the content() field.
long	content_length()
String	contentString()	the text contents of the source file in the normal case.
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new ShadercIncludeResult.Buffer instance allocated on the specified MemoryStack.
static ShadercIncludeResult	malloc(MemoryStack stack)	Returns a new ShadercIncludeResult instance allocated on the specified MemoryStack.
static ShadercIncludeResult	mallocStack()	Deprecated.
static ShadercIncludeResult.Buffer	mallocStack(int capacity)	Deprecated.
static ShadercIncludeResult.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static ShadercIncludeResult	mallocStack(MemoryStack stack)	Deprecated.
static ByteBuffer	ncontent(long struct)	Unsafe version of content().
static void	ncontent(long struct, ByteBuffer value)	Unsafe version of content.
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 String	ncontentString(long struct)	Unsafe version of contentString().
static ByteBuffer	nsource_name(long struct)	Unsafe version of source_name().
static void	nsource_name(long struct, ByteBuffer value)	Unsafe version of source_name.
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 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(ByteBuffer source_name, 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()	Returns sizeof(struct).
ByteBuffer	source_name()	the name of the source file.
ShadercIncludeResult	source_name(ByteBuffer value)	Sets the address of the specified encoded string to the source_name() field.
long	source_name_length()
String	source_nameString()	the name of the source file.
long	user_data()	user data to be passed along with this request
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.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

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 Details

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 Details

ShadercIncludeResult

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<ShadercIncludeResult>

source_name

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.

source_nameString

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.

source_name_length

public long source_name_length()

Returns:

the value of the source_name_length field.

content

public ByteBuffer content()

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

contentString

public String contentString()

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

content_length

public long content_length()

Returns:

the value of the content_length field.

user_data

public long user_data()

user data to be passed along with this request

source_name

public ShadercIncludeResult source_name(ByteBuffer value)

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

content

public ShadercIncludeResult content(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(ByteBuffer source_name,
 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

@Deprecated
public static ShadercIncludeResult mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static ShadercIncludeResult callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static ShadercIncludeResult mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static ShadercIncludeResult callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static ShadercIncludeResult.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static ShadercIncludeResult.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static ShadercIncludeResult.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static ShadercIncludeResult.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static ShadercIncludeResult malloc(MemoryStack stack)

Returns a new ShadercIncludeResult instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nsource_name

public static ByteBuffer nsource_name(long struct)

Unsafe version of source_name().

nsource_nameString

public static 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 ByteBuffer ncontent(long struct)

Unsafe version of content().

ncontentString

public static 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,
 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,
 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