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

public Class SpvcMslVertexAttribute

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

Defines MSL characteristics of a vertex attribute at a particular location.

After compilation, it is possible to query whether or not this location was used.

Deprecated; use SpvcMslShaderInterfaceVar.

Layout


struct spvc_msl_vertex_attribute {
    unsigned int location;
    unsigned int msl_buffer;
    unsigned int msl_offset;
    unsigned int msl_stride;
    spvc_bool per_instance;
    spvc_msl_vertex_format format;
    SpvBuiltIn builtin;
}

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
MSL_BUFFER

The struct member offsets.

public static final int
MSL_OFFSET

The struct member offsets.

public static final int
MSL_STRIDE

The struct member offsets.

public static final int
PER_INSTANCE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
SpvcMslVertexAttribute(ByteBuffer container)

Creates a SpvcMslVertexAttribute 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 SpvcMslVertexAttribute
builtin(int value)

Sets the specified value to the builtin field.

public static SpvcMslVertexAttribute
calloc()

Returns a new SpvcMslVertexAttribute instance allocated with memCalloc.

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

Returns a new SpvcMslVertexAttribute.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new SpvcMslVertexAttribute instance allocated with BufferUtils.

public static SpvcMslVertexAttribute
create(long address)

Returns a new SpvcMslVertexAttribute instance for the specified memory address.

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

Returns a new SpvcMslVertexAttribute.Buffer instance allocated with BufferUtils.

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

Create a SpvcMslVertexAttribute.Buffer instance at the specified memory.

public static SpvcMslVertexAttribute
createSafe(long address)

Like create, but returns null if address is NULL.

public static SpvcMslVertexAttribute.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 SpvcMslVertexAttribute
format(int value)

Sets the specified value to the format field.

public int

Returns:

the value of the location field.
location
()

public SpvcMslVertexAttribute
location(int value)

Sets the specified value to the location field.

public static SpvcMslVertexAttribute
malloc()

Returns a new SpvcMslVertexAttribute instance allocated with memAlloc.

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

Returns a new SpvcMslVertexAttribute.Buffer instance allocated with memAlloc.

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

Returns a new SpvcMslVertexAttribute instance allocated on the specified MemoryStack.

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

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

public int
msl_buffer()

Obsolete, do not use.

public SpvcMslVertexAttribute
msl_buffer(int value)

Sets the specified value to the msl_buffer field.

public int
msl_offset()

Obsolete, do not use.

public SpvcMslVertexAttribute
msl_offset(int value)

Sets the specified value to the msl_offset field.

public int
msl_stride()

Obsolete, do not use.

public SpvcMslVertexAttribute
msl_stride(int value)

Sets the specified value to the msl_stride field.

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
nmsl_buffer(long struct)

Unsafe version of msl_buffer.

public static void
nmsl_buffer(long struct, int value)

Unsafe version of msl_buffer.

public static int
nmsl_offset(long struct)

Unsafe version of msl_offset.

public static void
nmsl_offset(long struct, int value)

Unsafe version of msl_offset.

public static int
nmsl_stride(long struct)

Unsafe version of msl_stride.

public static void
nmsl_stride(long struct, int value)

Unsafe version of msl_stride.

public static boolean
nper_instance(long struct)

Unsafe version of per_instance.

public static void
nper_instance(long struct, boolean value)

Unsafe version of per_instance.

public boolean
per_instance()

Obsolete, do not use.

public SpvcMslVertexAttribute
per_instance(boolean value)

Sets the specified value to the per_instance field.

public SpvcMslVertexAttribute
set(int location, int msl_buffer, int msl_offset, int msl_stride, boolean per_instance, int format, int builtin)

Initializes this struct with the specified values.

public SpvcMslVertexAttribute

Returns:

this struct
set
(SpvcMslVertexAttribute
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).
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.

MSL_BUFFERback to summary
public static final int MSL_BUFFER

The struct member offsets.

MSL_OFFSETback to summary
public static final int MSL_OFFSET

The struct member offsets.

MSL_STRIDEback to summary
public static final int MSL_STRIDE

The struct member offsets.

PER_INSTANCEback to summary
public static final int PER_INSTANCE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

SpvcMslVertexAttributeback to summary
protected SpvcMslVertexAttribute(long address, ByteBuffer container)
SpvcMslVertexAttributeback to summary
public SpvcMslVertexAttribute(ByteBuffer container)

Creates a SpvcMslVertexAttribute 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 SpvcMslVertexAttribute builtin(int value)

Sets the specified value to the builtin field.

callocback to summary
public static SpvcMslVertexAttribute calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static SpvcMslVertexAttribute calloc(MemoryStack stack)

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

Returns a new SpvcMslVertexAttribute.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 SpvcMslVertexAttribute 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 SpvcMslVertexAttribute create()

Returns a new SpvcMslVertexAttribute instance allocated with BufferUtils.

createback to summary
public static SpvcMslVertexAttribute create(long address)

Returns a new SpvcMslVertexAttribute instance for the specified memory address.

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

Returns a new SpvcMslVertexAttribute.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a SpvcMslVertexAttribute.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static SpvcMslVertexAttribute createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static SpvcMslVertexAttribute.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 SpvcMslVertexAttribute 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 int
locationback to summary
public SpvcMslVertexAttribute location(int value)

Sets the specified value to the location field.

mallocback to summary
public static SpvcMslVertexAttribute malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static SpvcMslVertexAttribute malloc(MemoryStack stack)

Returns a new SpvcMslVertexAttribute instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

msl_bufferback to summary
public int msl_buffer()

Obsolete, do not use. Only lingers on for ABI compatibility.

Annotations
@NativeType:unsigned int
msl_bufferback to summary
public SpvcMslVertexAttribute msl_buffer(int value)

Sets the specified value to the msl_buffer field.

msl_offsetback to summary
public int msl_offset()

Obsolete, do not use. Only lingers on for ABI compatibility.

Annotations
@NativeType:unsigned int
msl_offsetback to summary
public SpvcMslVertexAttribute msl_offset(int value)

Sets the specified value to the msl_offset field.

msl_strideback to summary
public int msl_stride()

Obsolete, do not use. Only lingers on for ABI compatibility.

Annotations
@NativeType:unsigned int
msl_strideback to summary
public SpvcMslVertexAttribute msl_stride(int value)

Sets the specified value to the msl_stride field.

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.

nmsl_bufferback to summary
public static int nmsl_buffer(long struct)

Unsafe version of msl_buffer.

nmsl_bufferback to summary
public static void nmsl_buffer(long struct, int value)

Unsafe version of msl_buffer.

nmsl_offsetback to summary
public static int nmsl_offset(long struct)

Unsafe version of msl_offset.

nmsl_offsetback to summary
public static void nmsl_offset(long struct, int value)

Unsafe version of msl_offset.

nmsl_strideback to summary
public static int nmsl_stride(long struct)

Unsafe version of msl_stride.

nmsl_strideback to summary
public static void nmsl_stride(long struct, int value)

Unsafe version of msl_stride.

nper_instanceback to summary
public static boolean nper_instance(long struct)

Unsafe version of per_instance.

nper_instanceback to summary
public static void nper_instance(long struct, boolean value)

Unsafe version of per_instance.

per_instanceback to summary
public boolean per_instance()

Obsolete, do not use. Only lingers on for ABI compatibility.

Annotations
@NativeType:spvc_bool
per_instanceback to summary
public SpvcMslVertexAttribute per_instance(boolean value)

Sets the specified value to the per_instance field.

setback to summary
public SpvcMslVertexAttribute set(int location, int msl_buffer, int msl_offset, int msl_stride, boolean per_instance, int format, int builtin)

Initializes this struct with the specified values.

setback to summary
public SpvcMslVertexAttribute set(SpvcMslVertexAttribute src)

Copies the specified struct data to this struct.

Parameters
src:SpvcMslVertexAttribute

the source struct

Returns:SpvcMslVertexAttribute

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
org.lwjgl.util.spvc back to summary

public Class SpvcMslVertexAttribute.Buffer

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

An array of SpvcMslVertexAttribute structs.

Field Summary

Modifier and TypeField and Description
private static final SpvcMslVertexAttribute

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new SpvcMslVertexAttribute.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 SpvcMslVertexAttribute.Buffer
builtin(int value)

Sets the specified value to the builtin field.

public int

Returns:

the value of the format field.
format
()

public SpvcMslVertexAttribute.Buffer
format(int value)

Sets the specified value to the format field.

protected SpvcMslVertexAttribute
public int

Returns:

the value of the location field.
location
()

public SpvcMslVertexAttribute.Buffer
location(int value)

Sets the specified value to the location field.

public int

Returns:

the value of the SpvcMslVertexAttribute#msl_buffer field.
msl_buffer
()

public SpvcMslVertexAttribute.Buffer
msl_buffer(int value)

Sets the specified value to the SpvcMslVertexAttribute#msl_buffer field.

public int

Returns:

the value of the SpvcMslVertexAttribute#msl_offset field.
msl_offset
()

public SpvcMslVertexAttribute.Buffer
msl_offset(int value)

Sets the specified value to the SpvcMslVertexAttribute#msl_offset field.

public int

Returns:

the value of the SpvcMslVertexAttribute#msl_stride field.
msl_stride
()

public SpvcMslVertexAttribute.Buffer
msl_stride(int value)

Sets the specified value to the SpvcMslVertexAttribute#msl_stride field.

public boolean

Returns:

the value of the SpvcMslVertexAttribute#per_instance field.
per_instance
()

public SpvcMslVertexAttribute.Buffer
per_instance(boolean value)

Sets the specified value to the SpvcMslVertexAttribute#per_instance field.

protected SpvcMslVertexAttribute.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final SpvcMslVertexAttribute ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new SpvcMslVertexAttribute.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 SpvcMslVertexAttribute#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 SpvcMslVertexAttribute.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 SpvcMslVertexAttribute.Buffer format(int value)

Sets the specified value to the format field.

getElementFactoryback to summary
protected SpvcMslVertexAttribute 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 int
locationback to summary
public SpvcMslVertexAttribute.Buffer location(int value)

Sets the specified value to the location field.

msl_bufferback to summary
public int msl_buffer()
Returns:int

the value of the SpvcMslVertexAttribute#msl_buffer field.

Annotations
@NativeType:unsigned int
msl_bufferback to summary
public SpvcMslVertexAttribute.Buffer msl_buffer(int value)

Sets the specified value to the SpvcMslVertexAttribute#msl_buffer field.

msl_offsetback to summary
public int msl_offset()
Returns:int

the value of the SpvcMslVertexAttribute#msl_offset field.

Annotations
@NativeType:unsigned int
msl_offsetback to summary
public SpvcMslVertexAttribute.Buffer msl_offset(int value)

Sets the specified value to the SpvcMslVertexAttribute#msl_offset field.

msl_strideback to summary
public int msl_stride()
Returns:int

the value of the SpvcMslVertexAttribute#msl_stride field.

Annotations
@NativeType:unsigned int
msl_strideback to summary
public SpvcMslVertexAttribute.Buffer msl_stride(int value)

Sets the specified value to the SpvcMslVertexAttribute#msl_stride field.

per_instanceback to summary
public boolean per_instance()
Returns:boolean

the value of the SpvcMslVertexAttribute#per_instance field.

Annotations
@NativeType:spvc_bool
per_instanceback to summary
public SpvcMslVertexAttribute.Buffer per_instance(boolean value)

Sets the specified value to the SpvcMslVertexAttribute#per_instance field.

selfback to summary
protected SpvcMslVertexAttribute.Buffer self()

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

Annotations
@Override