|
34 | 34 | DPPL_C_EXTERN_C_BEGIN |
35 | 35 |
|
36 | 36 | /*! |
37 | | - * @brief Crete USM shared memory. |
| 37 | + * @brief Create USM shared memory. |
38 | 38 | * |
39 | 39 | * @param size Number of bytes to allocate |
40 | 40 | * @param QRef Sycl queue reference to use in allocation |
41 | 41 | * |
42 | | - * @return The pointer to USM shared memory. |
| 42 | + * @return The pointer to USM shared memory. On failure, returns nullptr. |
43 | 43 | */ |
44 | 44 | DPPL_API |
45 | 45 | __dppl_give DPPLSyclUSMRef |
46 | 46 | DPPLmalloc_shared (size_t size, __dppl_keep const DPPLSyclQueueRef QRef); |
47 | 47 |
|
48 | 48 | /*! |
49 | | - * @brief Crete USM shared memory. |
| 49 | + * @brief Create USM shared memory. |
50 | 50 | * |
51 | 51 | * @param alignment Allocation's byte alignment |
52 | 52 | * @param size Number of bytes to allocate |
53 | 53 | * @param QRef Sycl queue reference to use in allocation |
54 | 54 | * |
55 | 55 | * @return The pointer to USM shared memory with the requested alignment. |
| 56 | + * On failure, returns nullptr. |
56 | 57 | */ |
57 | 58 | DPPL_API |
58 | 59 | __dppl_give DPPLSyclUSMRef |
59 | 60 | DPPLaligned_alloc_shared (size_t alignment, size_t size, |
60 | 61 | __dppl_keep const DPPLSyclQueueRef QRef); |
61 | 62 |
|
62 | 63 | /*! |
63 | | - * @brief Crete USM host memory. |
| 64 | + * @brief Create USM host memory. |
64 | 65 | * |
65 | 66 | * @param size Number of bytes to allocate |
66 | 67 | * @param QRef Sycl queue reference to use in allocation |
67 | 68 | * |
68 | | - * @return The pointer to USM host memory. |
| 69 | + * @return The pointer to USM host memory. On failure, returns nullptr. |
69 | 70 | */ |
70 | 71 | DPPL_API |
71 | 72 | __dppl_give DPPLSyclUSMRef |
72 | 73 | DPPLmalloc_host (size_t size, __dppl_keep const DPPLSyclQueueRef QRef); |
73 | 74 |
|
74 | 75 | /*! |
75 | | - * @brief Crete USM host memory. |
| 76 | + * @brief Create USM host memory. |
76 | 77 | * |
77 | 78 | * @param alignment Allocation's byte alignment |
78 | 79 | * @param size Number of bytes to allocate |
79 | 80 | * @param QRef Sycl queue reference to use in allocation |
80 | 81 | * |
81 | 82 | * @return The pointer to USM host memory with the requested alignment. |
| 83 | + * On failure, returns nullptr. |
82 | 84 | */ |
83 | 85 | DPPL_API |
84 | 86 | __dppl_give DPPLSyclUSMRef |
85 | 87 | DPPLaligned_alloc_host (size_t alignment, size_t size, |
86 | 88 | __dppl_keep const DPPLSyclQueueRef QRef); |
87 | 89 |
|
88 | 90 | /*! |
89 | | - * @brief Crete USM device memory. |
| 91 | + * @brief Create USM device memory. |
90 | 92 | * |
91 | 93 | * @param size Number of bytes to allocate |
92 | 94 | * @param QRef Sycl queue reference to use in allocation |
93 | 95 | * |
94 | | - * @return The pointer to USM device memory. |
| 96 | + * @return The pointer to USM device memory. On failure, returns nullptr. |
95 | 97 | */ |
96 | 98 | DPPL_API |
97 | 99 | __dppl_give DPPLSyclUSMRef |
98 | 100 | DPPLmalloc_device (size_t size, __dppl_keep const DPPLSyclQueueRef QRef); |
99 | 101 |
|
100 | 102 | /*! |
101 | | - * @brief Crete USM device memory. |
| 103 | + * @brief Create USM device memory. |
102 | 104 | * |
103 | 105 | * @param alignment Allocation's byte alignment |
104 | 106 | * @param size Number of bytes to allocate |
105 | 107 | * @param QRef Sycl queue reference to use in allocation |
106 | 108 | * |
107 | 109 | * @return The pointer to USM device memory with requested alignment. |
| 110 | + * On failure, returns nullptr. |
108 | 111 | */ |
109 | 112 | DPPL_API |
110 | 113 | __dppl_give DPPLSyclUSMRef |
|
0 commit comments