Skip to content

Commit 46ea036

Browse files
veselypetaveselypeta
authored
Merge pull request #554 from veselypeta/petr/549/get-info-validation
Make GetInfo queries consistent and tested
2 parents 758c7e2 + 5b5e28b commit 46ea036

28 files changed

+756
-84
lines changed

‎include/ur_api.h

+99-12
Original file line numberDiff line numberDiff line change
@@ -436,6 +436,17 @@ typedef enum ur_platform_info_t {
436436
/// + `NULL == hPlatform`
437437
/// - ::UR_RESULT_ERROR_INVALID_ENUMERATION
438438
/// + `::UR_PLATFORM_INFO_BACKEND < propName`
439+
/// - ::UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
440+
/// + If `propName` is not supported by the adapter.
441+
/// - ::UR_RESULT_ERROR_INVALID_SIZE
442+
/// + `propSize == 0 && pPropValue != NULL`
443+
/// + If `propSize` is less than the real number of bytes needed to return the info.
444+
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
445+
/// + `propSize != 0 && pPropValue == NULL`
446+
/// + `pPropValue == NULL && pPropSizeRet == NULL`
447+
/// - ::UR_RESULT_ERROR_INVALID_PLATFORM
448+
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
449+
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
439450
UR_APIEXPORT ur_result_t UR_APICALL
440451
urPlatformGetInfo(
441452
ur_platform_handle_t hPlatform, ///< [in] handle of the platform
@@ -446,7 +457,7 @@ urPlatformGetInfo(
446457
///< If Size is not equal to or greater to the real number of bytes needed
447458
///< to return the info then the ::UR_RESULT_ERROR_INVALID_SIZE error is
448459
///< returned and pPlatformInfo is not used.
449-
size_t *pSizeRet ///< [out][optional] pointer to the actual number of bytes being queried by pPlatformInfo.
460+
size_t *pPropSizeRet ///< [out][optional] pointer to the actual number of bytes being queried by pPlatformInfo.
450461
);
451462

452463
///////////////////////////////////////////////////////////////////////////////
@@ -937,8 +948,17 @@ typedef enum ur_device_info_t {
937948
/// + `NULL == hDevice`
938949
/// - ::UR_RESULT_ERROR_INVALID_ENUMERATION
939950
/// + `::UR_DEVICE_INFO_MAX_REGISTERS_PER_WORK_GROUP < propName`
951+
/// - ::UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
940952
/// + If `propName` is not supported by the adapter.
941-
/// - ::UR_RESULT_ERROR_INVALID_VALUE
953+
/// - ::UR_RESULT_ERROR_INVALID_SIZE
954+
/// + `propSize == 0 && pPropValue != NULL`
955+
/// + If `propSize` is less than the real number of bytes needed to return the info.
956+
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
957+
/// + `propSize != 0 && pPropValue == NULL`
958+
/// + `pPropValue == NULL && pPropSizeRet == NULL`
959+
/// - ::UR_RESULT_ERROR_INVALID_DEVICE
960+
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
961+
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
942962
UR_APIEXPORT ur_result_t UR_APICALL
943963
urDeviceGetInfo(
944964
ur_device_handle_t hDevice, ///< [in] handle of the device instance
@@ -948,7 +968,7 @@ urDeviceGetInfo(
948968
///< the info.
949969
///< If propSize is not equal to or greater than the real number of bytes
950970
///< needed to return the info
951-
///< then the ::UR_RESULT_ERROR_INVALID_VALUE error is returned and
971+
///< then the ::UR_RESULT_ERROR_INVALID_SIZE error is returned and
952972
///< pPropValue is not used.
953973
size_t *pPropSizeRet ///< [out][optional] pointer to the actual size in bytes of the queried propName.
954974
);
@@ -1522,6 +1542,17 @@ urContextRelease(
15221542
/// + `NULL == hContext`
15231543
/// - ::UR_RESULT_ERROR_INVALID_ENUMERATION
15241544
/// + `::UR_CONTEXT_INFO_ATOMIC_FENCE_SCOPE_CAPABILITIES < propName`
1545+
/// - ::UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
1546+
/// + If `propName` is not supported by the adapter.
1547+
/// - ::UR_RESULT_ERROR_INVALID_SIZE
1548+
/// + `propSize == 0 && pPropValue != NULL`
1549+
/// + If `propSize` is less than the real number of bytes needed to return the info.
1550+
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
1551+
/// + `propSize != 0 && pPropValue == NULL`
1552+
/// + `pPropValue == NULL && pPropSizeRet == NULL`
1553+
/// - ::UR_RESULT_ERROR_INVALID_CONTEXT
1554+
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
1555+
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
15251556
UR_APIEXPORT ur_result_t UR_APICALL
15261557
urContextGetInfo(
15271558
ur_context_handle_t hContext, ///< [in] handle of the context
@@ -2116,6 +2147,17 @@ urMemImageCreateWithNativeHandle(
21162147
/// + `NULL == hMemory`
21172148
/// - ::UR_RESULT_ERROR_INVALID_ENUMERATION
21182149
/// + `::UR_MEM_INFO_CONTEXT < propName`
2150+
/// - ::UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
2151+
/// + If `propName` is not supported by the adapter.
2152+
/// - ::UR_RESULT_ERROR_INVALID_SIZE
2153+
/// + `propSize == 0 && pPropValue != NULL`
2154+
/// + If `propSize` is less than the real number of bytes needed to return the info.
2155+
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
2156+
/// + `propSize != 0 && pPropValue == NULL`
2157+
/// + `pPropValue == NULL && pPropSizeRet == NULL`
2158+
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
2159+
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
2160+
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
21192161
UR_APIEXPORT ur_result_t UR_APICALL
21202162
urMemGetInfo(
21212163
ur_mem_handle_t hMemory, ///< [in] handle to the memory object being queried.
@@ -2316,15 +2358,17 @@ urSamplerRelease(
23162358
/// + `NULL == hSampler`
23172359
/// - ::UR_RESULT_ERROR_INVALID_ENUMERATION
23182360
/// + `::UR_SAMPLER_INFO_FILTER_MODE < propName`
2319-
/// - ::UR_RESULT_ERROR_INVALID_SAMPLER
2320-
/// - ::UR_RESULT_ERROR_INVALID_VALUE
2321-
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
2322-
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
2361+
/// - ::UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
2362+
/// + If `propName` is not supported by the adapter.
23232363
/// - ::UR_RESULT_ERROR_INVALID_SIZE
23242364
/// + `propSize == 0 && pPropValue != NULL`
2365+
/// + If `propSize` is less than the real number of bytes needed to return the info.
23252366
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
23262367
/// + `propSize != 0 && pPropValue == NULL`
23272368
/// + `pPropValue == NULL && pPropSizeRet == NULL`
2369+
/// - ::UR_RESULT_ERROR_INVALID_SAMPLER
2370+
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
2371+
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
23282372
UR_APIEXPORT ur_result_t UR_APICALL
23292373
urSamplerGetInfo(
23302374
ur_sampler_handle_t hSampler, ///< [in] handle of the sampler object
@@ -2841,7 +2885,15 @@ typedef enum ur_usm_pool_info_t {
28412885
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
28422886
/// + `NULL == pPropValue`
28432887
/// + `NULL == pPropSizeRet`
2844-
/// - ::UR_RESULT_ERROR_INVALID_VALUE
2888+
/// + `propSize != 0 && pPropValue == NULL`
2889+
/// + `pPropValue == NULL && pPropSizeRet == NULL`
2890+
/// - ::UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
2891+
/// + If `propName` is not supported by the adapter.
2892+
/// - ::UR_RESULT_ERROR_INVALID_SIZE
2893+
/// + `propSize == 0 && pPropValue != NULL`
2894+
/// + If `propSize` is less than the real number of bytes needed to return the info.
2895+
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
2896+
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
28452897
UR_APIEXPORT ur_result_t UR_APICALL
28462898
urUSMPoolGetInfo(
28472899
ur_usm_pool_handle_t hPool, ///< [in] handle of the USM memory pool
@@ -3202,6 +3254,17 @@ typedef enum ur_program_info_t {
32023254
/// + `NULL == hProgram`
32033255
/// - ::UR_RESULT_ERROR_INVALID_ENUMERATION
32043256
/// + `::UR_PROGRAM_INFO_KERNEL_NAMES < propName`
3257+
/// - ::UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
3258+
/// + If `propName` is not supported by the adapter.
3259+
/// - ::UR_RESULT_ERROR_INVALID_SIZE
3260+
/// + `propSize == 0 && pPropValue != NULL`
3261+
/// + If `propSize` is less than the real number of bytes needed to return the info.
3262+
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
3263+
/// + `propSize != 0 && pPropValue == NULL`
3264+
/// + `pPropValue == NULL && pPropSizeRet == NULL`
3265+
/// - ::UR_RESULT_ERROR_INVALID_PROGRAM
3266+
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
3267+
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
32053268
UR_APIEXPORT ur_result_t UR_APICALL
32063269
urProgramGetInfo(
32073270
ur_program_handle_t hProgram, ///< [in] handle of the Program object
@@ -3563,6 +3626,17 @@ typedef enum ur_kernel_exec_info_t {
35633626
/// + `NULL == hKernel`
35643627
/// - ::UR_RESULT_ERROR_INVALID_ENUMERATION
35653628
/// + `::UR_KERNEL_INFO_NUM_REGS < propName`
3629+
/// - ::UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
3630+
/// + If `propName` is not supported by the adapter.
3631+
/// - ::UR_RESULT_ERROR_INVALID_SIZE
3632+
/// + `propSize == 0 && pPropValue != NULL`
3633+
/// + If `propSize` is less than the real number of bytes needed to return the info.
3634+
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
3635+
/// + `propSize != 0 && pPropValue == NULL`
3636+
/// + `pPropValue == NULL && pPropSizeRet == NULL`
3637+
/// - ::UR_RESULT_ERROR_INVALID_KERNEL
3638+
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
3639+
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
35663640
UR_APIEXPORT ur_result_t UR_APICALL
35673641
urKernelGetInfo(
35683642
ur_kernel_handle_t hKernel, ///< [in] handle of the Kernel object
@@ -3948,8 +4022,15 @@ typedef enum ur_queue_flag_t {
39484022
/// + `NULL == hQueue`
39494023
/// - ::UR_RESULT_ERROR_INVALID_ENUMERATION
39504024
/// + `::UR_QUEUE_INFO_EMPTY < propName`
4025+
/// - ::UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
4026+
/// + If `propName` is not supported by the adapter.
4027+
/// - ::UR_RESULT_ERROR_INVALID_SIZE
4028+
/// + `propSize == 0 && pPropValue != NULL`
4029+
/// + If `propSize` is less than the real number of bytes needed to return the info.
4030+
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
4031+
/// + `propSize != 0 && pPropValue == NULL`
4032+
/// + `pPropValue == NULL && pPropSizeRet == NULL`
39514033
/// - ::UR_RESULT_ERROR_INVALID_QUEUE
3952-
/// - ::UR_RESULT_ERROR_INVALID_VALUE
39534034
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
39544035
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
39554036
UR_APIEXPORT ur_result_t UR_APICALL
@@ -4315,8 +4396,14 @@ typedef enum ur_profiling_info_t {
43154396
/// + `NULL == hEvent`
43164397
/// - ::UR_RESULT_ERROR_INVALID_ENUMERATION
43174398
/// + `::UR_EVENT_INFO_REFERENCE_COUNT < propName`
4318-
/// - ::UR_RESULT_ERROR_INVALID_VALUE
4319-
/// + `pPropValue && propSize == 0`
4399+
/// - ::UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
4400+
/// + If `propName` is not supported by the adapter.
4401+
/// - ::UR_RESULT_ERROR_INVALID_SIZE
4402+
/// + `propSize == 0 && pPropValue != NULL`
4403+
/// + If `propSize` is less than the real number of bytes needed to return the info.
4404+
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
4405+
/// + `propSize != 0 && pPropValue == NULL`
4406+
/// + `pPropValue == NULL && pPropSizeRet == NULL`
43204407
/// - ::UR_RESULT_ERROR_INVALID_EVENT
43214408
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
43224409
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
@@ -5894,7 +5981,7 @@ typedef struct ur_platform_get_info_params_t {
58945981
ur_platform_info_t *ppropName;
58955982
size_t *ppropSize;
58965983
void **ppPropValue;
5897-
size_t **ppSizeRet;
5984+
size_t **ppPropSizeRet;
58985985
} ur_platform_get_info_params_t;
58995986

59005987
///////////////////////////////////////////////////////////////////////////////

‎scripts/core/context.yml

+12
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,18 @@ params:
161161
name: pPropSizeRet
162162
desc: |
163163
[out][optional] pointer to the actual size in bytes of the queried propName.
164+
returns:
165+
- $X_RESULT_ERROR_UNSUPPORTED_ENUMERATION:
166+
- "If `propName` is not supported by the adapter."
167+
- $X_RESULT_ERROR_INVALID_SIZE:
168+
- "`propSize == 0 && pPropValue != NULL`"
169+
- "If `propSize` is less than the real number of bytes needed to return the info."
170+
- $X_RESULT_ERROR_INVALID_NULL_POINTER:
171+
- "`propSize != 0 && pPropValue == NULL`"
172+
- "`pPropValue == NULL && pPropSizeRet == NULL`"
173+
- $X_RESULT_ERROR_INVALID_CONTEXT
174+
- $X_RESULT_ERROR_OUT_OF_RESOURCES
175+
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
164176
--- #--------------------------------------------------------------------------
165177
type: function
166178
desc: "Return platform native context handle."

‎scripts/core/device.yml

+11-3
Original file line numberDiff line numberDiff line change
@@ -409,15 +409,23 @@ params:
409409
desc: |
410410
[out][optional][typename(propName, propSize)] array of bytes holding the info.
411411
If propSize is not equal to or greater than the real number of bytes needed to return the info
412-
then the $X_RESULT_ERROR_INVALID_VALUE error is returned and pPropValue is not used.
412+
then the $X_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
413413
- type: "size_t*"
414414
name: pPropSizeRet
415415
desc: |
416416
[out][optional] pointer to the actual size in bytes of the queried propName.
417417
returns:
418-
- $X_RESULT_ERROR_INVALID_ENUMERATION:
418+
- $X_RESULT_ERROR_UNSUPPORTED_ENUMERATION:
419419
- "If `propName` is not supported by the adapter."
420-
- $X_RESULT_ERROR_INVALID_VALUE
420+
- $X_RESULT_ERROR_INVALID_SIZE:
421+
- "`propSize == 0 && pPropValue != NULL`"
422+
- "If `propSize` is less than the real number of bytes needed to return the info."
423+
- $X_RESULT_ERROR_INVALID_NULL_POINTER:
424+
- "`propSize != 0 && pPropValue == NULL`"
425+
- "`pPropValue == NULL && pPropSizeRet == NULL`"
426+
- $X_RESULT_ERROR_INVALID_DEVICE
427+
- $X_RESULT_ERROR_OUT_OF_RESOURCES
428+
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
421429
--- #--------------------------------------------------------------------------
422430
type: function
423431
desc: "Makes a reference of the device handle indicating it's in use until paired $xDeviceRelease is called"

‎scripts/core/event.yml

+8-2
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,14 @@ params:
145145
name: pPropSizeRet
146146
desc: "[out][optional] bytes returned in event property"
147147
returns:
148-
- $X_RESULT_ERROR_INVALID_VALUE:
149-
- "`pPropValue && propSize == 0`"
148+
- $X_RESULT_ERROR_UNSUPPORTED_ENUMERATION:
149+
- "If `propName` is not supported by the adapter."
150+
- $X_RESULT_ERROR_INVALID_SIZE:
151+
- "`propSize == 0 && pPropValue != NULL`"
152+
- "If `propSize` is less than the real number of bytes needed to return the info."
153+
- $X_RESULT_ERROR_INVALID_NULL_POINTER:
154+
- "`propSize != 0 && pPropValue == NULL`"
155+
- "`pPropValue == NULL && pPropSizeRet == NULL`"
150156
- $X_RESULT_ERROR_INVALID_EVENT
151157
- $X_RESULT_ERROR_OUT_OF_RESOURCES
152158
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY

‎scripts/core/kernel.yml

+12
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,18 @@ params:
190190
name: "pPropSizeRet"
191191
desc: |
192192
[out][optional] pointer to the actual size in bytes of data being queried by propName.
193+
returns:
194+
- $X_RESULT_ERROR_UNSUPPORTED_ENUMERATION:
195+
- "If `propName` is not supported by the adapter."
196+
- $X_RESULT_ERROR_INVALID_SIZE:
197+
- "`propSize == 0 && pPropValue != NULL`"
198+
- "If `propSize` is less than the real number of bytes needed to return the info."
199+
- $X_RESULT_ERROR_INVALID_NULL_POINTER:
200+
- "`propSize != 0 && pPropValue == NULL`"
201+
- "`pPropValue == NULL && pPropSizeRet == NULL`"
202+
- $X_RESULT_ERROR_INVALID_KERNEL
203+
- $X_RESULT_ERROR_OUT_OF_RESOURCES
204+
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
193205
--- #--------------------------------------------------------------------------
194206
type: function
195207
desc: "Query work Group information about a Kernel object"

‎scripts/core/memory.yml

+12
Original file line numberDiff line numberDiff line change
@@ -532,6 +532,18 @@ params:
532532
name: pPropSizeRet
533533
desc: |
534534
[out][optional] pointer to the actual size in bytes of the queried propName.
535+
returns:
536+
- $X_RESULT_ERROR_UNSUPPORTED_ENUMERATION:
537+
- "If `propName` is not supported by the adapter."
538+
- $X_RESULT_ERROR_INVALID_SIZE:
539+
- "`propSize == 0 && pPropValue != NULL`"
540+
- "If `propSize` is less than the real number of bytes needed to return the info."
541+
- $X_RESULT_ERROR_INVALID_NULL_POINTER:
542+
- "`propSize != 0 && pPropValue == NULL`"
543+
- "`pPropValue == NULL && pPropSizeRet == NULL`"
544+
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
545+
- $X_RESULT_ERROR_OUT_OF_RESOURCES
546+
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
535547
--- #--------------------------------------------------------------------------
536548
type: function
537549
desc: "Retrieve information about an image object."

‎scripts/core/platform.yml

+13-1
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,21 @@ params:
9696
[out][optional][typename(propName, propSize)] array of bytes holding the info.
9797
If Size is not equal to or greater to the real number of bytes needed to return the info then the $X_RESULT_ERROR_INVALID_SIZE error is returned and pPlatformInfo is not used.
9898
- type: "size_t*"
99-
name: pSizeRet
99+
name: pPropSizeRet
100100
desc: |
101101
[out][optional] pointer to the actual number of bytes being queried by pPlatformInfo.
102+
returns:
103+
- $X_RESULT_ERROR_UNSUPPORTED_ENUMERATION:
104+
- "If `propName` is not supported by the adapter."
105+
- $X_RESULT_ERROR_INVALID_SIZE:
106+
- "`propSize == 0 && pPropValue != NULL`"
107+
- "If `propSize` is less than the real number of bytes needed to return the info."
108+
- $X_RESULT_ERROR_INVALID_NULL_POINTER:
109+
- "`propSize != 0 && pPropValue == NULL`"
110+
- "`pPropValue == NULL && pPropSizeRet == NULL`"
111+
- $X_RESULT_ERROR_INVALID_PLATFORM
112+
- $X_RESULT_ERROR_OUT_OF_RESOURCES
113+
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
102114
--- #--------------------------------------------------------------------------
103115
type: enum
104116
desc: "Supported API versions"

‎scripts/core/program.yml

+12
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,18 @@ params:
357357
name: "pPropSizeRet"
358358
desc: |
359359
[out][optional] pointer to the actual size in bytes of the queried propName.
360+
returns:
361+
- $X_RESULT_ERROR_UNSUPPORTED_ENUMERATION:
362+
- "If `propName` is not supported by the adapter."
363+
- $X_RESULT_ERROR_INVALID_SIZE:
364+
- "`propSize == 0 && pPropValue != NULL`"
365+
- "If `propSize` is less than the real number of bytes needed to return the info."
366+
- $X_RESULT_ERROR_INVALID_NULL_POINTER:
367+
- "`propSize != 0 && pPropValue == NULL`"
368+
- "`pPropValue == NULL && pPropSizeRet == NULL`"
369+
- $X_RESULT_ERROR_INVALID_PROGRAM
370+
- $X_RESULT_ERROR_OUT_OF_RESOURCES
371+
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
360372
--- #--------------------------------------------------------------------------
361373
type: enum
362374
desc: "Program object build status"

‎scripts/core/queue.yml

+8-2
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,18 @@ params:
8585
name: pPropSizeRet
8686
desc: "[out][optional] size in bytes returned in queue property value"
8787
returns:
88+
- $X_RESULT_ERROR_UNSUPPORTED_ENUMERATION:
89+
- "If `propName` is not supported by the adapter."
90+
- $X_RESULT_ERROR_INVALID_SIZE:
91+
- "`propSize == 0 && pPropValue != NULL`"
92+
- "If `propSize` is less than the real number of bytes needed to return the info."
93+
- $X_RESULT_ERROR_INVALID_NULL_POINTER:
94+
- "`propSize != 0 && pPropValue == NULL`"
95+
- "`pPropValue == NULL && pPropSizeRet == NULL`"
8896
- $X_RESULT_ERROR_INVALID_QUEUE
89-
- $X_RESULT_ERROR_INVALID_VALUE
9097
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
9198
- $X_RESULT_ERROR_OUT_OF_RESOURCES
9299
--- #--------------------------------------------------------------------------
93-
94100
type: struct
95101
desc: "Queue creation properties"
96102
class: $xQueue

‎scripts/core/sampler.yml

+8-6
Original file line numberDiff line numberDiff line change
@@ -160,15 +160,17 @@ params:
160160
name: pPropSizeRet
161161
desc: "[out][optional] size in bytes returned in sampler property value"
162162
returns:
163+
- $X_RESULT_ERROR_UNSUPPORTED_ENUMERATION:
164+
- "If `propName` is not supported by the adapter."
165+
- $X_RESULT_ERROR_INVALID_SIZE:
166+
- "`propSize == 0 && pPropValue != NULL`"
167+
- "If `propSize` is less than the real number of bytes needed to return the info."
168+
- $X_RESULT_ERROR_INVALID_NULL_POINTER:
169+
- "`propSize != 0 && pPropValue == NULL`"
170+
- "`pPropValue == NULL && pPropSizeRet == NULL`"
163171
- $X_RESULT_ERROR_INVALID_SAMPLER
164-
- $X_RESULT_ERROR_INVALID_VALUE
165172
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
166173
- $X_RESULT_ERROR_OUT_OF_RESOURCES
167-
- $X_RESULT_ERROR_INVALID_SIZE:
168-
- "`propSize == 0 && pPropValue != NULL`"
169-
- $X_RESULT_ERROR_INVALID_NULL_POINTER:
170-
- "`propSize != 0 && pPropValue == NULL`"
171-
- "`pPropValue == NULL && pPropSizeRet == NULL`"
172174
--- #--------------------------------------------------------------------------
173175
type: function
174176
desc: "Return sampler native sampler handle."

0 commit comments

Comments
 (0)