Table of Contents

Struct GraphicProcessorControl.ImageGrabResult

Namespace
CapCognition.Maui.Core.Shared
Assembly
CapCognition.Maui.Core.dll
public ref struct GraphicProcessorControl.ImageGrabResult
Inherited Members

Constructors

ImageGrabResult()

public ImageGrabResult()

ImageGrabResult(int, int)

public ImageGrabResult(int frameNo, int processorIndex)

Parameters

frameNo int
processorIndex int

Fields

Bitmap

Set the grabbed bitmap here.

Note: The bitmap ownership is transferred to the processing system. If you return null here, no processing will be done for this request and the next grab image callback is done right after waiting for DelayBeforeNextRequestInMilliseconds.

Important: If you always return null here and no DelayBeforeNextRequestInMilliseconds is set, a busy loop will occur!

public SKBitmap? Bitmap

Field Value

SKBitmap

ContinueRequest

Define whether continuous processing should continue or stop.

public GraphicProcessorControl.ImageGrabResult.ContinuousRequest ContinueRequest

Field Value

GraphicProcessorControl.ImageGrabResult.ContinuousRequest

DelayBeforeNextRequestInMilliseconds

Set the delay, in milliseconds, to wait before processing next frame. Use this value to do a throttling (constant or variable) of the frame rate.

Note: You have to set this value in each callback invocation to have an effect.

public int? DelayBeforeNextRequestInMilliseconds

Field Value

int?

Remarks

Set this value to control the interval between consecutive requests. If null, no delay is applied.

FrameNo

Gets the frame number. The frame number is incremented with each request when a frame got processed.

public readonly long FrameNo

Field Value

long

ProcessorIndex

Gets the index of the processor that is requesting the image in a parallel processing scenario.

public readonly int ProcessorIndex

Field Value

int

Remarks

This value is typically used to identify or coordinate work among multiple processors operating in parallel. The index is zero-based.

Properties

ContinueProcessing

Helper property to check whether processing should continue.

public readonly bool ContinueProcessing { get; }

Property Value

bool