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

public Class SpvcMslShaderInterfaceVar

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

Defines MSL characteristics of an input variable at a particular location.

After compilation, it is possible to query whether or not this location was used. If vecsize is nonzero, it must be greater than or equal to the vecsize declared in the shader, or behavior is undefined.

Deprecated; use spvc_msl_shader_interface_var_2.

Layout


struct spvc_msl_shader_interface_var {
    unsigned location;
    spvc_msl_vertex_format format;
    SpvBuiltIn builtin;
    unsigned vecsize;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BUILTIN

The struct member offsets.

public static final int
FORMAT

The struct member offsets.

public static final int
LOCATION

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
VECSIZE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
SpvcMslShaderInterfaceVar(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the builtin field.
builtin
()

public SpvcMslShaderInterfaceVar
builtin(int value)

Sets the specified value to the builtin field.

public static SpvcMslShaderInterfaceVar
calloc()

Returns a new SpvcMslShaderInterfaceVar instance allocated with memCalloc.

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

Returns a new SpvcMslShaderInterfaceVar.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new SpvcMslShaderInterfaceVar instance allocated with BufferUtils.

public static SpvcMslShaderInterfaceVar
create(long address)

Returns a new SpvcMslShaderInterfaceVar instance for the specified memory address.

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

Returns a new SpvcMslShaderInterfaceVar.Buffer instance allocated with BufferUtils.

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

Create a SpvcMslShaderInterfaceVar.Buffer instance at the specified memory.

public static SpvcMslShaderInterfaceVar
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the format field.
format
()

public SpvcMslShaderInterfaceVar
format(int value)

Sets the specified value to the format field.

public int

Returns:

the value of the location field.
location
()

public SpvcMslShaderInterfaceVar
location(int value)

Sets the specified value to the location field.

public static SpvcMslShaderInterfaceVar
malloc()

Returns a new SpvcMslShaderInterfaceVar instance allocated with memAlloc.

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

Returns a new SpvcMslShaderInterfaceVar.Buffer instance allocated with memAlloc.

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

Returns a new SpvcMslShaderInterfaceVar instance allocated on the specified MemoryStack.

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

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

public static int
nbuiltin(long struct)

Unsafe version of builtin.

public static void
nbuiltin(long struct, int value)

Unsafe version of builtin.

public static int
nformat(long struct)

Unsafe version of format.

public static void
nformat(long struct, int value)

Unsafe version of format.

public static int
nlocation(long struct)

Unsafe version of location.

public static void
nlocation(long struct, int value)

Unsafe version of location.

public static int
nvecsize(long struct)

Unsafe version of vecsize.

public static void
nvecsize(long struct, int value)

Unsafe version of vecsize.

public SpvcMslShaderInterfaceVar
set(int location, int format, int builtin, int vecsize)

Initializes this struct with the specified values.

public SpvcMslShaderInterfaceVar

Returns:

this struct
set
(SpvcMslShaderInterfaceVar
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 int

Returns:

the value of the vecsize field.
vecsize
()

public SpvcMslShaderInterfaceVar
vecsize(int value)

Sets the specified value to the vecsize field.

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.

BUILTINback to summary
public static final int BUILTIN

The struct member offsets.

FORMATback to summary
public static final int FORMAT

The struct member offsets.

LOCATIONback to summary
public static final int LOCATION

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

VECSIZEback to summary
public static final int VECSIZE

The struct member offsets.

Constructor Detail

SpvcMslShaderInterfaceVarback to summary
protected SpvcMslShaderInterfaceVar(long address, ByteBuffer container)
SpvcMslShaderInterfaceVarback to summary
public SpvcMslShaderInterfaceVar(ByteBuffer container)

Creates a SpvcMslShaderInterfaceVar 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

builtinback to summary
public int builtin()
Returns:int

the value of the builtin field.

Annotations
@NativeType:SpvBuiltIn
builtinback to summary
public SpvcMslShaderInterfaceVar builtin(int value)

Sets the specified value to the builtin field.

callocback to summary
public static SpvcMslShaderInterfaceVar calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static SpvcMslShaderInterfaceVar calloc(MemoryStack stack)

Returns a new SpvcMslShaderInterfaceVar 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 SpvcMslShaderInterfaceVar.Buffer calloc(int capacity, MemoryStack stack)

Returns a new SpvcMslShaderInterfaceVar.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

createback to summary
protected SpvcMslShaderInterfaceVar 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 SpvcMslShaderInterfaceVar create()

Returns a new SpvcMslShaderInterfaceVar instance allocated with BufferUtils.

createback to summary
public static SpvcMslShaderInterfaceVar create(long address)

Returns a new SpvcMslShaderInterfaceVar instance for the specified memory address.

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

Returns a new SpvcMslShaderInterfaceVar.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a SpvcMslShaderInterfaceVar.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static SpvcMslShaderInterfaceVar createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
formatback to summary
public int format()
Returns:int

the value of the format field.

Annotations
@NativeType:spvc_msl_vertex_format
formatback to summary
public SpvcMslShaderInterfaceVar format(int value)

Sets the specified value to the format field.

locationback to summary
public int location()
Returns:int

the value of the location field.

Annotations
@NativeType:unsigned
locationback to summary
public SpvcMslShaderInterfaceVar location(int value)

Sets the specified value to the location field.

mallocback to summary
public static SpvcMslShaderInterfaceVar malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static SpvcMslShaderInterfaceVar malloc(MemoryStack stack)

Returns a new SpvcMslShaderInterfaceVar instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbuiltinback to summary
public static int nbuiltin(long struct)

Unsafe version of builtin.

nbuiltinback to summary
public static void nbuiltin(long struct, int value)

Unsafe version of builtin.

nformatback to summary
public static int nformat(long struct)

Unsafe version of format.

nformatback to summary
public static void nformat(long struct, int value)

Unsafe version of format.

nlocationback to summary
public static int nlocation(long struct)

Unsafe version of location.

nlocationback to summary
public static void nlocation(long struct, int value)

Unsafe version of location.

nvecsizeback to summary
public static int nvecsize(long struct)

Unsafe version of vecsize.

nvecsizeback to summary
public static void nvecsize(long struct, int value)

Unsafe version of vecsize.

setback to summary
public SpvcMslShaderInterfaceVar set(int location, int format, int builtin, int vecsize)

Initializes this struct with the specified values.

setback to summary
public SpvcMslShaderInterfaceVar set(SpvcMslShaderInterfaceVar src)

Copies the specified struct data to this struct.

Parameters
src:SpvcMslShaderInterfaceVar

the source struct

Returns:SpvcMslShaderInterfaceVar

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
vecsizeback to summary
public int vecsize()
Returns:int

the value of the vecsize field.

Annotations
@NativeType:unsigned
vecsizeback to summary
public SpvcMslShaderInterfaceVar vecsize(int value)

Sets the specified value to the vecsize field.

org.lwjgl.util.spvc back to summary

public Class SpvcMslShaderInterfaceVar.Buffer

extends StructBuffer<SpvcMslShaderInterfaceVar, SpvcMslShaderInterfaceVar.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of SpvcMslShaderInterfaceVar structs.

Field Summary

Modifier and TypeField and Description
private static final SpvcMslShaderInterfaceVar

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new SpvcMslShaderInterfaceVar.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 int

Returns:

the value of the builtin field.
builtin
()

public SpvcMslShaderInterfaceVar.Buffer
builtin(int value)

Sets the specified value to the builtin field.

public int

Returns:

the value of the format field.
format
()

public SpvcMslShaderInterfaceVar.Buffer
format(int value)

Sets the specified value to the format field.

protected SpvcMslShaderInterfaceVar
public int

Returns:

the value of the location field.
location
()

public SpvcMslShaderInterfaceVar.Buffer
location(int value)

Sets the specified value to the location field.

protected SpvcMslShaderInterfaceVar.Buffer
public int

Returns:

the value of the vecsize field.
vecsize
()

public SpvcMslShaderInterfaceVar.Buffer
vecsize(int value)

Sets the specified value to the vecsize field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final SpvcMslShaderInterfaceVar ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new SpvcMslShaderInterfaceVar.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 SpvcMslShaderInterfaceVar#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

builtinback to summary
public int builtin()
Returns:int

the value of the builtin field.

Annotations
@NativeType:SpvBuiltIn
builtinback to summary
public SpvcMslShaderInterfaceVar.Buffer builtin(int value)

Sets the specified value to the builtin field.

formatback to summary
public int format()
Returns:int

the value of the format field.

Annotations
@NativeType:spvc_msl_vertex_format
formatback to summary
public SpvcMslShaderInterfaceVar.Buffer format(int value)

Sets the specified value to the format field.

getElementFactoryback to summary
protected SpvcMslShaderInterfaceVar getElementFactory()

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

Annotations
@Override
locationback to summary
public int location()
Returns:int

the value of the location field.

Annotations
@NativeType:unsigned
locationback to summary
public SpvcMslShaderInterfaceVar.Buffer location(int value)

Sets the specified value to the location field.

selfback to summary
protected SpvcMslShaderInterfaceVar.Buffer self()

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

Annotations
@Override
vecsizeback to summary
public int vecsize()
Returns:int

the value of the vecsize field.

Annotations
@NativeType:unsigned
vecsizeback to summary
public SpvcMslShaderInterfaceVar.Buffer vecsize(int value)

Sets the specified value to the vecsize field.