summaryrefslogtreecommitdiff
path: root/renderscript/include/rs_io.rsh
blob: 2ffbe4bd4ce0d66d66bb7e15d1709dbeb990c5d4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

// Don't edit this file!  It is auto-generated by frameworks/rs/api/generate.sh.

/*
 * rs_io.rsh: Input/Output Functions
 *
 * These functions are used to:
 * - Send information to the Java client, and
 * - Send the processed allocation or receive the next allocation to process.
 */

#ifndef RENDERSCRIPT_RS_IO_RSH
#define RENDERSCRIPT_RS_IO_RSH

/*
 * rsAllocationIoReceive: Receive new content from the queue
 *
 * Receive a new set of contents from the queue.
 *
 * This function should not be called from inside a kernel, or from any function
 * that may be called directly or indirectly from a kernel. Doing so would cause a
 * runtime error.
 *
 * Parameters:
 *   a: Allocation to work on.
 */
#if (defined(RS_VERSION) && (RS_VERSION >= 16))
extern void __attribute__((overloadable))
    rsAllocationIoReceive(rs_allocation a);
#endif

/*
 * rsAllocationIoSend: Send new content to the queue
 *
 * Send the contents of the Allocation to the queue.
 *
 * This function should not be called from inside a kernel, or from any function
 * that may be called directly or indirectly from a kernel. Doing so would cause a
 * runtime error.
 *
 * Parameters:
 *   a: Allocation to work on.
 */
#if (defined(RS_VERSION) && (RS_VERSION >= 16))
extern void __attribute__((overloadable))
    rsAllocationIoSend(rs_allocation a);
#endif

/*
 * rsSendToClient: Send a message to the client, non-blocking
 *
 * Sends a message back to the client.  This call does not block.
 * It returns true if the message was sent and false if the
 * message queue is full.
 *
 * A message ID is required.  The data payload is optional.
 *
 * See RenderScript.RSMessageHandler.
 *
 * Parameters:
 *   data: Application specific data.
 *   len: Length of the data, in bytes.
 */
extern bool __attribute__((overloadable))
    rsSendToClient(int cmdID);

extern bool __attribute__((overloadable))
    rsSendToClient(int cmdID, const void* data, uint len);

/*
 * rsSendToClientBlocking: Send a message to the client, blocking
 *
 * Sends a message back to the client.  This function will block
 * until there is room on the message queue for this message.
 * This function may return before the message was delivered and
 * processed by the client.
 *
 * A message ID is required.  The data payload is optional.
 *
 * See RenderScript.RSMessageHandler.
 *
 * Parameters:
 *   data: Application specific data.
 *   len: Length of the data, in bytes.
 */
extern void __attribute__((overloadable))
    rsSendToClientBlocking(int cmdID);

extern void __attribute__((overloadable))
    rsSendToClientBlocking(int cmdID, const void* data, uint len);

#endif // RENDERSCRIPT_RS_IO_RSH