Top Description Inners Fields Constructors Methods
org.lwjgl.opencl

public Class CLDeviceIntegerDotProductAccelerationPropertiesKHR

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

Describes the exact dot product operations that are accelerated on the device.

A dot product operation is deemed accelerated if its implementation provides a performance advantage over application-provided code composed from elementary instructions and/or other dot product instructions, either because the implementation uses optimized machine code sequences whose generation from application-provided code cannot be guaranteed or because it uses hardware features that cannot otherwise be targeted from application-provided code.

Layout


struct cl_device_integer_dot_product_acceleration_properties_khr {
    cl_bool signed_accelerated;
    cl_bool unsigned_accelerated;
    cl_bool mixed_signedness_accelerated;
    cl_bool accumulating_saturating_signed_accelerated;
    cl_bool accumulating_saturating_unsigned_accelerated;
    cl_bool accumulating_saturating_mixed_signedness_accelerated;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
public static final int
public static final int
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MIXED_SIGNEDNESS_ACCELERATED

The struct member offsets.

public static final int
SIGNED_ACCELERATED

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
UNSIGNED_ACCELERATED

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
CLDeviceIntegerDotProductAccelerationPropertiesKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public boolean
accumulating_saturating_mixed_signedness_accelerated()

is TRUE when accumulating saturating mixed signedness dot product operations are accelerated, FALSE otherwise

public boolean
accumulating_saturating_signed_accelerated()

is TRUE when accumulating saturating signed dot product operations are accelerated, FALSE otherwise

public boolean
accumulating_saturating_unsigned_accelerated()

is TRUE when accumulating saturating unsigned dot product operations are accelerated, FALSE otherwise

public static CLDeviceIntegerDotProductAccelerationPropertiesKHR
calloc()

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR instance allocated with memCalloc.

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

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR instance allocated with BufferUtils.

public static CLDeviceIntegerDotProductAccelerationPropertiesKHR
create(long address)

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR instance for the specified memory address.

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

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR.Buffer instance allocated with BufferUtils.

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

Create a CLDeviceIntegerDotProductAccelerationPropertiesKHR.Buffer instance at the specified memory.

public static CLDeviceIntegerDotProductAccelerationPropertiesKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static CLDeviceIntegerDotProductAccelerationPropertiesKHR
malloc()

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR instance allocated with memAlloc.

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

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR.Buffer instance allocated with memAlloc.

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

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR instance allocated on the specified MemoryStack.

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

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

public boolean
mixed_signedness_accelerated()

is TRUE when mixed signedness dot product operations are accelerated, FALSE otherwise

public static int
public static int
public static int
public static int
public static int
nsigned_accelerated(long struct)

Unsafe version of signed_accelerated.

public static int
nunsigned_accelerated(long struct)

Unsafe version of unsigned_accelerated.

public boolean
signed_accelerated()

is TRUE when signed dot product operations are accelerated, FALSE otherwise

public int
sizeof()

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

Returns sizeof(struct).
public boolean
unsigned_accelerated()

is TRUE when unsigned dot product operations are accelerated, FALSE otherwise

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

ACCUMULATING_SATURATING_MIXED_SIGNEDNESS_ACCELERATEDback to summary
public static final int ACCUMULATING_SATURATING_MIXED_SIGNEDNESS_ACCELERATED

The struct member offsets.

ACCUMULATING_SATURATING_SIGNED_ACCELERATEDback to summary
public static final int ACCUMULATING_SATURATING_SIGNED_ACCELERATED

The struct member offsets.

ACCUMULATING_SATURATING_UNSIGNED_ACCELERATEDback to summary
public static final int ACCUMULATING_SATURATING_UNSIGNED_ACCELERATED

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

MIXED_SIGNEDNESS_ACCELERATEDback to summary
public static final int MIXED_SIGNEDNESS_ACCELERATED

The struct member offsets.

SIGNED_ACCELERATEDback to summary
public static final int SIGNED_ACCELERATED

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

UNSIGNED_ACCELERATEDback to summary
public static final int UNSIGNED_ACCELERATED

The struct member offsets.

Constructor Detail

CLDeviceIntegerDotProductAccelerationPropertiesKHRback to summary
protected CLDeviceIntegerDotProductAccelerationPropertiesKHR(long address, ByteBuffer container)
CLDeviceIntegerDotProductAccelerationPropertiesKHRback to summary
public CLDeviceIntegerDotProductAccelerationPropertiesKHR(ByteBuffer container)

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

accumulating_saturating_mixed_signedness_acceleratedback to summary
public boolean accumulating_saturating_mixed_signedness_accelerated()

is TRUE when accumulating saturating mixed signedness dot product operations are accelerated, FALSE otherwise

Annotations
@NativeType:cl_bool
accumulating_saturating_signed_acceleratedback to summary
public boolean accumulating_saturating_signed_accelerated()

is TRUE when accumulating saturating signed dot product operations are accelerated, FALSE otherwise

Annotations
@NativeType:cl_bool
accumulating_saturating_unsigned_acceleratedback to summary
public boolean accumulating_saturating_unsigned_accelerated()

is TRUE when accumulating saturating unsigned dot product operations are accelerated, FALSE otherwise

Annotations
@NativeType:cl_bool
callocback to summary
public static CLDeviceIntegerDotProductAccelerationPropertiesKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CLDeviceIntegerDotProductAccelerationPropertiesKHR calloc(MemoryStack stack)

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

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

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR instance allocated with BufferUtils.

createback to summary
public static CLDeviceIntegerDotProductAccelerationPropertiesKHR create(long address)

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR instance for the specified memory address.

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

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CLDeviceIntegerDotProductAccelerationPropertiesKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CLDeviceIntegerDotProductAccelerationPropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CLDeviceIntegerDotProductAccelerationPropertiesKHR malloc(MemoryStack stack)

Returns a new CLDeviceIntegerDotProductAccelerationPropertiesKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mixed_signedness_acceleratedback to summary
public boolean mixed_signedness_accelerated()

is TRUE when mixed signedness dot product operations are accelerated, FALSE otherwise

Annotations
@NativeType:cl_bool
naccumulating_saturating_mixed_signedness_acceleratedback to summary
public static int naccumulating_saturating_mixed_signedness_accelerated(long struct)

Unsafe version of accumulating_saturating_mixed_signedness_accelerated.

naccumulating_saturating_signed_acceleratedback to summary
public static int naccumulating_saturating_signed_accelerated(long struct)

Unsafe version of accumulating_saturating_signed_accelerated.

naccumulating_saturating_unsigned_acceleratedback to summary
public static int naccumulating_saturating_unsigned_accelerated(long struct)

Unsafe version of accumulating_saturating_unsigned_accelerated.

nmixed_signedness_acceleratedback to summary
public static int nmixed_signedness_accelerated(long struct)

Unsafe version of mixed_signedness_accelerated.

nsigned_acceleratedback to summary
public static int nsigned_accelerated(long struct)

Unsafe version of signed_accelerated.

nunsigned_acceleratedback to summary
public static int nunsigned_accelerated(long struct)

Unsafe version of unsigned_accelerated.

signed_acceleratedback to summary
public boolean signed_accelerated()

is TRUE when signed dot product operations are accelerated, FALSE otherwise

Annotations
@NativeType:cl_bool
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
unsigned_acceleratedback to summary
public boolean unsigned_accelerated()

is TRUE when unsigned dot product operations are accelerated, FALSE otherwise

Annotations
@NativeType:cl_bool
org.lwjgl.opencl back to summary

public Class CLDeviceIntegerDotProductAccelerationPropertiesKHR.Buffer

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

An array of CLDeviceIntegerDotProductAccelerationPropertiesKHR structs.

Field Summary

Modifier and TypeField and Description
private static final CLDeviceIntegerDotProductAccelerationPropertiesKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CLDeviceIntegerDotProductAccelerationPropertiesKHR.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 boolean
public boolean
public boolean
protected CLDeviceIntegerDotProductAccelerationPropertiesKHR
public boolean
protected CLDeviceIntegerDotProductAccelerationPropertiesKHR.Buffer
public boolean
public boolean
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CLDeviceIntegerDotProductAccelerationPropertiesKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

accumulating_saturating_mixed_signedness_acceleratedback to summary
public boolean accumulating_saturating_mixed_signedness_accelerated()
Returns:boolean

the value of the CLDeviceIntegerDotProductAccelerationPropertiesKHR#accumulating_saturating_mixed_signedness_accelerated field.

Annotations
@NativeType:cl_bool
accumulating_saturating_signed_acceleratedback to summary
public boolean accumulating_saturating_signed_accelerated()
Returns:boolean

the value of the CLDeviceIntegerDotProductAccelerationPropertiesKHR#accumulating_saturating_signed_accelerated field.

Annotations
@NativeType:cl_bool
accumulating_saturating_unsigned_acceleratedback to summary
public boolean accumulating_saturating_unsigned_accelerated()
Returns:boolean

the value of the CLDeviceIntegerDotProductAccelerationPropertiesKHR#accumulating_saturating_unsigned_accelerated field.

Annotations
@NativeType:cl_bool
getElementFactoryback to summary
protected CLDeviceIntegerDotProductAccelerationPropertiesKHR getElementFactory()

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

Annotations
@Override
mixed_signedness_acceleratedback to summary
public boolean mixed_signedness_accelerated()
Returns:boolean

the value of the CLDeviceIntegerDotProductAccelerationPropertiesKHR#mixed_signedness_accelerated field.

Annotations
@NativeType:cl_bool
selfback to summary
protected CLDeviceIntegerDotProductAccelerationPropertiesKHR.Buffer self()

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

Annotations
@Override
signed_acceleratedback to summary
public boolean signed_accelerated()
Returns:boolean

the value of the CLDeviceIntegerDotProductAccelerationPropertiesKHR#signed_accelerated field.

Annotations
@NativeType:cl_bool
unsigned_acceleratedback to summary
public boolean unsigned_accelerated()
Returns:boolean

the value of the CLDeviceIntegerDotProductAccelerationPropertiesKHR#unsigned_accelerated field.

Annotations
@NativeType:cl_bool