Top Description Inners Fields Constructors Methods
com.jogamp.opencl

public Class CLSampler

extends CLObjectResource
Class Inheritance
Imports
com.jogamp.common.nio.PointerBuffer, com.jogamp.opencl.impl.CLTLInfoAccessor, com.jogamp.opencl.llb.CLSamplerBinding, java.nio.Buffer
Object representing an OpenCL sampler.
Author
Michael Bien, et al.
See Also
CLContext#createSampler(com.jogamp.opencl.CLSampler.AddressingMode, com.jogamp.opencl.CLSampler.FilteringMode, boolean)

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
CLSampler.AddressingMode

private class
CLSampler.CLSamplerInfoAccessor

public static enum
CLSampler.FilteringMode

Field Summary

Modifier and TypeField and Description
private final CLSamplerBinding
binding

private final CLSampler.CLSamplerInfoAccessor
samplerInfo

Constructor Summary

AccessConstructor and Description
private
CLSampler(final CLContext context, final long id, final CLSampler.AddressingMode addrMode, final CLSampler.FilteringMode filtMode, final boolean normalizedCoords)

Method Summary

Modifier and TypeMethod and Description
pack-priv static CLSampler
create(final CLContext context, final CLSampler.AddressingMode addrMode, final CLSampler.FilteringMode filtMode, final boolean normalizedCoords)

public CLSampler.AddressingMode
getAddressingMode()

public CLSampler.FilteringMode
getFilteringMode()

public boolean
hasNormalizedCoords()

public void
release()

Overrides com.jogamp.opencl.CLObjectResource.release.

Implements com.jogamp.opencl.CLResource.release.

Releases the OpenCL resource.
Inherited from com.jogamp.opencl.CLObjectResource:
closeisReleased

Field Detail

bindingback to summary
private final CLSamplerBinding binding
samplerInfoback to summary
private final CLSampler.CLSamplerInfoAccessor samplerInfo

Constructor Detail

CLSamplerback to summary
private CLSampler(final CLContext context, final long id, final CLSampler.AddressingMode addrMode, final CLSampler.FilteringMode filtMode, final boolean normalizedCoords)

Method Detail

createback to summary
pack-priv static CLSampler create(final CLContext context, final CLSampler.AddressingMode addrMode, final CLSampler.FilteringMode filtMode, final boolean normalizedCoords)
getAddressingModeback to summary
public CLSampler.AddressingMode getAddressingMode()
getFilteringModeback to summary
public CLSampler.FilteringMode getFilteringMode()
hasNormalizedCoordsback to summary
public boolean hasNormalizedCoords()
releaseback to summary
public void release()

Overrides com.jogamp.opencl.CLObjectResource.release.

Implements com.jogamp.opencl.CLResource.release.

Doc from com.jogamp.opencl.CLResource.release.

Releases the OpenCL resource.

Annotations
@Override
com.jogamp.opencl back to summary

public final Enum CLSampler.AddressingMode

extends Enum<CLSampler.AddressingMode>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final CLSampler.AddressingMode
CLAMP

public static final CLSampler.AddressingMode
CLAMP_TO_EDGE

public final int
MODE

Value of wrapped OpenCL sampler addressing mode type.

public static final CLSampler.AddressingMode
NONE

public static final CLSampler.AddressingMode
REPEAT

Constructor Summary

AccessConstructor and Description
private
AddressingMode(final int mode)

Method Summary

Modifier and TypeMethod and Description
public static CLSampler.AddressingMode
valueOf(String name)

public static CLSampler.AddressingMode
valueOf(final int mode)

public static CLSampler.AddressingMode[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CLAMPback to summary
public static final CLSampler.AddressingMode CLAMP
CLAMP_TO_EDGEback to summary
public static final CLSampler.AddressingMode CLAMP_TO_EDGE
MODEback to summary
public final int MODE

Value of wrapped OpenCL sampler addressing mode type.

NONEback to summary
public static final CLSampler.AddressingMode NONE
REPEATback to summary
public static final CLSampler.AddressingMode REPEAT

Constructor Detail

AddressingModeback to summary
private AddressingMode(final int mode)

Method Detail

valueOfback to summary
public static CLSampler.AddressingMode valueOf(String name)
valueOfback to summary
public static CLSampler.AddressingMode valueOf(final int mode)
valuesback to summary
public static CLSampler.AddressingMode[] values()
com.jogamp.opencl back to summary

private Class CLSampler.CLSamplerInfoAccessor

extends CLTLInfoAccessor
Class Inheritance

Field Summary

Inherited from com.jogamp.opencl.impl.CLTLInfoAccessor:
localBBlocalNSB

Constructor Summary

AccessConstructor and Description
private
CLSamplerInfoAccessor()

Method Summary

Modifier and TypeMethod and Description
protected int
getInfo(final int name, final long valueSize, final Buffer value, final PointerBuffer valueSizeRet)

Implements abstract com.jogamp.opencl.impl.CLTLInfoAccessor.getInfo.

Inherited from com.jogamp.opencl.impl.CLTLInfoAccessor:
getBBgetIntsgetLonggetNSBgetStringgetUInt32Long

Constructor Detail

CLSamplerInfoAccessorback to summary
private CLSamplerInfoAccessor()

Method Detail

getInfoback to summary
protected int getInfo(final int name, final long valueSize, final Buffer value, final PointerBuffer valueSizeRet)

Implements abstract com.jogamp.opencl.impl.CLTLInfoAccessor.getInfo.

Annotations
@Override
com.jogamp.opencl back to summary

public final Enum CLSampler.FilteringMode

extends Enum<CLSampler.FilteringMode>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final CLSampler.FilteringMode
LINEAR

public final int
MODE

Value of wrapped OpenCL sampler filtering mode type.

public static final CLSampler.FilteringMode
NEAREST

Constructor Summary

AccessConstructor and Description
private
FilteringMode(final int mode)

Method Summary

Modifier and TypeMethod and Description
public static CLSampler.FilteringMode
valueOf(String name)

public static CLSampler.FilteringMode
valueOf(final int mode)

public static CLSampler.FilteringMode[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

LINEARback to summary
public static final CLSampler.FilteringMode LINEAR
MODEback to summary
public final int MODE

Value of wrapped OpenCL sampler filtering mode type.

NEARESTback to summary
public static final CLSampler.FilteringMode NEAREST

Constructor Detail

FilteringModeback to summary
private FilteringMode(final int mode)

Method Detail

valueOfback to summary
public static CLSampler.FilteringMode valueOf(String name)
valueOfback to summary
public static CLSampler.FilteringMode valueOf(final int mode)
valuesback to summary
public static CLSampler.FilteringMode[] values()