Method ReportAnnotationAsync
ReportAnnotationAsync(AnnotationDefinition)
Creates an async annotation for reporting the values for an annotation during a future frame.
Declaration
public AsyncAnnotation ReportAnnotationAsync(AnnotationDefinition annotationDefinition)
Parameters
Type | Name | Description |
---|---|---|
AnnotationDefinition | annotationDefinition | The AnnotationDefinition of this annotation. |
Returns
Type | Description |
---|---|
AsyncAnnotation | Returns a handle to the AsyncAnnotation, which can be used to report annotation data during a subsequent frame. |
Exceptions
Type | Condition |
---|---|
InvalidOperationException | Thrown if this method is called during a frame where ShouldCaptureThisFrame is false. |
ArgumentException | Thrown if the given AnnotationDefinition is invalid. |