Pipe Functions

Click an item in the table below for details about that function.

read_pipe Read packet from pipe
write_pipe Write packet to pipe
reserve_read_pipe Reserve entries for reading from pipe
reserve_write_pipe Reserve entries for writing to pipe
commit_read_pipe Indicates that all reads associated with a reservation are completed
commit_write_pipe Indicates that all writes associated with a reservation are completed
is_valid_reserve_id Test for a valid reservation ID
work_group_reserve_read_pipe Reserve entries for reading from pipe
work_group_reserve_write_pipe Reserve entries for writing to pipe
work_group_commit_read_pipe Indicates that all reads associated with a reservation are completed
work_group_commit_write_pipe Indicates that all writes associated with a reservation are completed
get_pipe_num_packets Returns the number of available entries in the pipe
get_pipe_max_packets Returns the maximum number of packets specified when pipe was created

Functions enabled by the cl_khr_subgroups extension:

sub_group_reserve_read_pipe Reserve entries for reading from a pipe
sub_group_reserve_write_pipe Reserve entries for writing to a pipe
sub_group_commit_read_pipe Indicates that all reads associated with a reservation are completed
sub_group_commit_write_pipe Indicates that all writes associated with a reservation are completed

Description

Specification

OpenCL Specification

Copyright © 2007-2013 The Khronos Group Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.