opencl vocabulary - Factor Documentation

opencl vocabulary
Factor handbook » Vocabulary index

Documentation
OpenCL

Metadata

Tags:	bindings, not tested
Authors:	Erik Charlebois

Words

Tuple classes

Class	Superclass	Slots
cl-buffer	cl-handle
cl-buffer-ptr	tuple	buffer offset
cl-buffer-range	tuple	buffer offset size
cl-context	cl-handle
cl-device	tuple	id type vendor-id max-compute-units max-work-item-dimensions max-work-item-sizes max-work-group-size preferred-vector-width-char preferred-vector-width-short preferred-vector-width-int preferred-vector-width-long preferred-vector-width-float preferred-vector-width-double max-clock-frequency address-bits max-mem-alloc-size image-support max-read-image-args max-write-image-args image2d-max-width image2d-max-height image3d-max-width image3d-max-height image3d-max-depth max-samplers max-parameter-size mem-base-addr-align min-data-type-align-size single-fp-config global-mem-cache-type global-mem-cacheline-size global-mem-cache-size global-mem-size max-constant-buffer-size max-constant-args local-mem? local-mem-size error-correction-support profiling-timer-resolution endian-little available compiler-available execute-kernels? execute-native-kernels? out-of-order-exec-available? profiling-available? name vendor driver-version profile version extensions
cl-event	cl-handle
cl-kernel	cl-handle
cl-platform	tuple	id profile version name vendor extensions devices
cl-program	cl-handle
cl-queue	cl-handle
cl-sampler	cl-handle

Singleton classes

cl-acquire-gl-objects-command

cl-channel-order-a

cl-channel-order-argb

cl-channel-order-bgra

cl-channel-order-intensity

cl-channel-order-luminance

cl-channel-order-rgba

cl-channel-type-float

cl-channel-type-half-float

cl-channel-type-signed-int16

cl-channel-type-signed-int32

cl-channel-type-signed-int8

cl-channel-type-snorm-int16

cl-channel-type-snorm-int8

cl-channel-type-unorm-int-101010

cl-channel-type-unorm-int16

cl-channel-type-unorm-int8

cl-channel-type-unorm-short-555

cl-channel-type-unorm-short-565

cl-channel-type-unsigned-int16

cl-channel-type-unsigned-int32

cl-channel-type-unsigned-int8

cl-clamp-addressing

cl-clamp-to-edge-addressing

cl-complete

cl-copy-buffer-command

cl-copy-buffer-to-image-command

cl-copy-image-command

cl-copy-image-to-buffer-command

cl-denorm

cl-device-accelerator

cl-map-buffer-command

cl-map-image-command

cl-marker-command

cl-native-kernel-command

cl-ndrange-kernel-command

cl-read-buffer-command

cl-read-image-command

cl-read-only-cache

cl-read-write-access

cl-read-write-cache

cl-release-gl-objects-command

cl-unmap-mem-object-command

cl-write-access

cl-write-buffer-command

cl-write-image-command

Mixin classes

cl-addressing-mode

cl-buffer-access-mode

cl-image-channel-order

cl-image-channel-type

Symbol words

cl-current-context

cl-current-device

cl-current-queue

Ordinary words

Word	Stack effect
<cl-buffer-ptr>	( buffer offset -- cl-buffer-ptr )
<cl-buffer-range>	( buffer offset size -- cl-buffer-range )
<cl-buffer>	( buffer-access-mode size initial-data -- buffer )
<cl-context>	( devices -- cl-context )
<cl-kernel>	( program kernel-name -- kernel )
<cl-program>	( options strings -- program )
<cl-queue>	( context device out-of-order? profiling? -- command-queue )
<cl-sampler>	( normalized-coords? addressing-mode filter-mode -- sampler )
cl-barrier	( -- )
cl-barrier-events	( event/events -- )
cl-event-status	( event -- execution-status )
cl-event-type	( event -- command-type )
cl-finish	( -- )
cl-flush	( -- )
cl-kernel-arity	( kernel -- arity )
cl-kernel-local-size	( kernel -- size )
cl-kernel-name	( kernel -- string )
cl-marker	( -- event )
cl-normalized-coords?	( sampler -- ? )
cl-out-of-order-execution?	( command-queue -- ? )
cl-platforms	( -- platforms )
cl-profile-counters	( event -- queued submitted started finished )
cl-profiling?	( command-queue -- ? )
cl-queue-copy-buffer	( src-buffer-ptr dst-buffer-ptr size dependent-events -- event )
cl-queue-kernel	( kernel args sizes dependent-events -- event )
cl-queue-read-buffer	( buffer-range alien dependent-events -- event )
cl-queue-write-buffer	( buffer-range alien dependent-events -- event )
cl-read-buffer	( buffer-range -- byte-array )
cl-wait	( event/events -- )
cl-write-buffer	( buffer-range byte-array -- )
sampler>cl-addressing-mode	( sampler -- addressing-mode )
sampler>cl-filter-mode	( sampler -- filter-mode )
size_t>cl-device-type	( size_t -- cl-device-type )
with-cl-state	( context/f device/f queue/f quot -- )

Class predicate words

Word	Stack effect
cl-acquire-gl-objects-command?	( object -- ? )
cl-addressing-mode?	( object -- ? )
cl-buffer-access-mode?	( object -- ? )
cl-buffer-ptr?	( object -- ? )
cl-buffer-range?	( object -- ? )
cl-buffer?	( object -- ? )
cl-cache-type?	( object -- ? )
cl-channel-order-a?	( object -- ? )
cl-channel-order-argb?	( object -- ? )
cl-channel-order-bgra?	( object -- ? )
cl-channel-order-intensity?	( object -- ? )
cl-channel-order-luminance?	( object -- ? )
cl-channel-order-r?	( object -- ? )
cl-channel-order-ra?	( object -- ? )
cl-channel-order-rg?	( object -- ? )
cl-channel-order-rga?	( object -- ? )
cl-channel-order-rgba?	( object -- ? )
cl-channel-type-float?	( object -- ? )
cl-channel-type-half-float?	( object -- ? )
cl-channel-type-signed-int16?	( object -- ? )
cl-channel-type-signed-int32?	( object -- ? )
cl-channel-type-signed-int8?	( object -- ? )
cl-channel-type-snorm-int16?	( object -- ? )
cl-channel-type-snorm-int8?	( object -- ? )
cl-channel-type-unorm-int-101010?	( object -- ? )
cl-channel-type-unorm-int16?	( object -- ? )
cl-channel-type-unorm-int8?	( object -- ? )
cl-channel-type-unorm-short-555?	( object -- ? )
cl-channel-type-unorm-short-565?	( object -- ? )
cl-channel-type-unsigned-int16?	( object -- ? )
cl-channel-type-unsigned-int32?	( object -- ? )
cl-channel-type-unsigned-int8?	( object -- ? )
cl-clamp-addressing?	( object -- ? )
cl-clamp-to-edge-addressing?	( object -- ? )
cl-command-type?	( object -- ? )
cl-complete?	( object -- ? )
cl-context?	( object -- ? )
cl-copy-buffer-command?	( object -- ? )
cl-copy-buffer-to-image-command?	( object -- ? )
cl-copy-image-command?	( object -- ? )
cl-copy-image-to-buffer-command?	( object -- ? )
cl-denorm?	( object -- ? )
cl-device-accelerator?	( object -- ? )
cl-device-cpu?	( object -- ? )
cl-device-default?	( object -- ? )
cl-device-gpu?	( object -- ? )
cl-device-type?	( object -- ? )
cl-device?	( object -- ? )
cl-event?	( object -- ? )
cl-execution-status?	( object -- ? )
cl-failure?	( object -- ? )
cl-filter-linear?	( object -- ? )
cl-filter-mode?	( object -- ? )
cl-filter-nearest?	( object -- ? )
cl-fma?	( object -- ? )
cl-fp-feature?	( object -- ? )
cl-image-channel-order?	( object -- ? )
cl-image-channel-type?	( object -- ? )
cl-inf-and-nan?	( object -- ? )
cl-kernel?	( object -- ? )
cl-map-buffer-command?	( object -- ? )
cl-map-image-command?	( object -- ? )
cl-marker-command?	( object -- ? )
cl-native-kernel-command?	( object -- ? )
cl-ndrange-kernel-command?	( object -- ? )
cl-no-addressing?	( object -- ? )
cl-no-cache?	( object -- ? )
cl-platform?	( object -- ? )
cl-program?	( object -- ? )
cl-queue?	( object -- ? )
cl-queued?	( object -- ? )
cl-read-access?	( object -- ? )
cl-read-buffer-command?	( object -- ? )
cl-read-image-command?	( object -- ? )
cl-read-only-cache?	( object -- ? )
cl-read-write-access?	( object -- ? )
cl-read-write-cache?	( object -- ? )
cl-release-gl-objects-command?	( object -- ? )
cl-repeat-addressing?	( object -- ? )
cl-round-to-inf?	( object -- ? )
cl-round-to-nearest?	( object -- ? )
cl-round-to-zero?	( object -- ? )
cl-running?	( object -- ? )
cl-sampler?	( object -- ? )
cl-submitted?	( object -- ? )
cl-task-command?	( object -- ? )
cl-unmap-mem-object-command?	( object -- ? )
cl-write-access?	( object -- ? )
cl-write-buffer-command?	( object -- ? )
cl-write-image-command?	( object -- ? )

Files

resource:extra/opencl/opencl.factor
resource:extra/opencl/opencl-docs.factor
resource:extra/opencl/opencl-tests.factor

Metadata files

resource:extra/opencl/authors.txt
resource:extra/opencl/summary.txt
resource:extra/opencl/tags.txt

Children from resource:extra

Vocabulary	Summary
opencl.ffi	Bindings to OpenCL
opencl.syntax