Top Description Inners Fields Constructors Methods
org.lwjgl.opencl

public final Class CLKernel

extends CLObjectChild<CLProgram>
Class Inheritance
This class is a wrapper around a cl_kernel pointer.
Author
Spasi

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static interface
CLKernel.CLKernelUtil

CLKernel utility methods interface.

Field Summary

Modifier and TypeField and Description
private static final CLKernel.CLKernelUtil
util

Constructor Summary

AccessConstructor and Description
pack-priv
CLKernel(final long pointer, final CLProgram program)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the parameter value
getInfoInt(final int
the parameter
param_name)

Returns the integer value of the specified parameter.

public String

Returns:

the parameter value
getInfoString(final int
the parameter
param_name)

Returns the String value of the specified parameter.

public long

Returns:

the parameter value
getWorkGroupInfoLong(final CLDevice device, int
the parameter
param_name)

Returns the long value of the specified parameter.

public long

Returns:

the parameter value
getWorkGroupInfoSize(final CLDevice device, int
the parameter
param_name)

Returns the size_t value of the specified parameter.

public long[]

Returns:

the parameter values
getWorkGroupInfoSizeArray(final CLDevice device, int
the parameter
param_name)

Returns an array of size_t values of the specified parameter.

pack-priv int
release()

Overrides org.lwjgl.opencl.CLObjectRetainable.release.

public CLKernel

Returns:

this CLKernel object
setArg(final int
the argument index
index, final byte
the argument value
value)

Sets a kernel argument at the specified index to the specified byte value.

public CLKernel

Returns:

this CLKernel object
setArg(final int
the argument index
index, final short
the argument value
value)

Sets a kernel argument at the specified index to the specified byte value.

public CLKernel

Returns:

this CLKernel object
setArg(final int
the argument index
index, final int
the argument value
value)

Sets a kernel argument at the specified index to the specified int value.

public CLKernel

Returns:

this CLKernel object
setArg(final int
the argument index
index, final long
the argument value
value)

Sets a kernel argument at the specified index to the specified long value.

public CLKernel

Returns:

this CLKernel object
setArg(final int
the argument index
index, final float
the argument value
value)

Sets a kernel argument at the specified index to the specified float value.

public CLKernel

Returns:

this CLKernel object
setArg(final int
the argument index
index, final double
the argument value
value)

Sets a kernel argument at the specified index to the specified double value.

public CLKernel

Returns:

this CLKernel object
setArg(final int
the argument index
index, final CLObject
the argument value
value)

Sets a kernel argument at the specified index to the specified pointer value.

public CLKernel

Returns:

this CLKernel object
setArgSize(final int
the argument index
index, final long
the argument size
size)

Sets the size of a __local kernel argument at the specified index.

Inherited from org.lwjgl.opencl.CLObjectChild:
getParent

Field Detail

utilback to summary
private static final CLKernel.CLKernelUtil util

Constructor Detail

CLKernelback to summary
pack-priv CLKernel(final long pointer, final CLProgram program)

Method Detail

getInfoIntback to summary
public int getInfoInt(final int param_name)

Returns the integer value of the specified parameter.

Parameters
param_name:int

the parameter

Returns:int

the parameter value

getInfoStringback to summary
public String getInfoString(final int param_name)

Returns the String value of the specified parameter.

Parameters
param_name:int

the parameter

Returns:String

the parameter value

getWorkGroupInfoLongback to summary
public long getWorkGroupInfoLong(final CLDevice device, int param_name)

Returns the long value of the specified parameter. Can be used for both cl_ulong and cl_bitfield parameters.

Parameters
param_name:int

the parameter

Returns:long

the parameter value

getWorkGroupInfoSizeback to summary
public long getWorkGroupInfoSize(final CLDevice device, int param_name)

Returns the size_t value of the specified parameter.

Parameters
param_name:int

the parameter

Returns:long

the parameter value

getWorkGroupInfoSizeArrayback to summary
public long[] getWorkGroupInfoSizeArray(final CLDevice device, int param_name)

Returns an array of size_t values of the specified parameter.

Parameters
param_name:int

the parameter

Returns:long[]

the parameter values

releaseback to summary
pack-priv int release()

Overrides org.lwjgl.opencl.CLObjectRetainable.release.

setArgback to summary
public CLKernel setArg(final int index, final byte value)

Sets a kernel argument at the specified index to the specified byte value.

Parameters
index:int

the argument index

value:byte

the argument value

Returns:CLKernel

this CLKernel object

setArgback to summary
public CLKernel setArg(final int index, final short value)

Sets a kernel argument at the specified index to the specified byte value.

Parameters
index:int

the argument index

value:short

the argument value

Returns:CLKernel

this CLKernel object

setArgback to summary
public CLKernel setArg(final int index, final int value)

Sets a kernel argument at the specified index to the specified int value.

Parameters
index:int

the argument index

value:int

the argument value

Returns:CLKernel

this CLKernel object

setArgback to summary
public CLKernel setArg(final int index, final long value)

Sets a kernel argument at the specified index to the specified long value.

Parameters
index:int

the argument index

value:long

the argument value

Returns:CLKernel

this CLKernel object

setArgback to summary
public CLKernel setArg(final int index, final float value)

Sets a kernel argument at the specified index to the specified float value.

Parameters
index:int

the argument index

value:float

the argument value

Returns:CLKernel

this CLKernel object

setArgback to summary
public CLKernel setArg(final int index, final double value)

Sets a kernel argument at the specified index to the specified double value.

Parameters
index:int

the argument index

value:double

the argument value

Returns:CLKernel

this CLKernel object

setArgback to summary
public CLKernel setArg(final int index, final CLObject value)

Sets a kernel argument at the specified index to the specified pointer value.

Parameters
index:int

the argument index

value:CLObject

the argument value

Returns:CLKernel

this CLKernel object

setArgSizeback to summary
public CLKernel setArgSize(final int index, final long size)

Sets the size of a __local kernel argument at the specified index.

Parameters
index:int

the argument index

size:long

the argument size

Returns:CLKernel

this CLKernel object

org.lwjgl.opencl back to summary

pack-priv Interface CLKernel.CLKernelUtil

extends InfoUtil<CLKernel>
Known Direct Implementers
org.lwjgl.opencl.InfoUtilFactory.CLKernelUtil
CLKernel utility methods interface.

Method Summary

Modifier and TypeMethod and Description
public long
getWorkGroupInfoLong(CLKernel kernel, CLDevice device, int param_name)

public long
getWorkGroupInfoSize(CLKernel kernel, CLDevice device, int param_name)

public long[]
getWorkGroupInfoSizeArray(CLKernel kernel, CLDevice device, int param_name)

public void
setArg(CLKernel kernel, int index, byte value)

public void
setArg(CLKernel kernel, int index, short value)

public void
setArg(CLKernel kernel, int index, int value)

public void
setArg(CLKernel kernel, int index, long value)

public void
setArg(CLKernel kernel, int index, float value)

public void
setArg(CLKernel kernel, int index, double value)

public void
setArg(CLKernel kernel, int index, CLObject pointer)

public void
setArgSize(CLKernel kernel, int index, long size)

Inherited from org.lwjgl.opencl.InfoUtil:
getInfoIntgetInfoLonggetInfoSizegetInfoSizeArraygetInfoString

Method Detail

getWorkGroupInfoLongback to summary
public long getWorkGroupInfoLong(CLKernel kernel, CLDevice device, int param_name)
getWorkGroupInfoSizeback to summary
public long getWorkGroupInfoSize(CLKernel kernel, CLDevice device, int param_name)
getWorkGroupInfoSizeArrayback to summary
public long[] getWorkGroupInfoSizeArray(CLKernel kernel, CLDevice device, int param_name)
setArgback to summary
public void setArg(CLKernel kernel, int index, byte value)
setArgback to summary
public void setArg(CLKernel kernel, int index, short value)
setArgback to summary
public void setArg(CLKernel kernel, int index, int value)
setArgback to summary
public void setArg(CLKernel kernel, int index, long value)
setArgback to summary
public void setArg(CLKernel kernel, int index, float value)
setArgback to summary
public void setArg(CLKernel kernel, int index, double value)
setArgback to summary
public void setArg(CLKernel kernel, int index, CLObject pointer)
setArgSizeback to summary
public void setArgSize(CLKernel kernel, int index, long size)