Namespaces
namespace	Grabbers

namespace	Options

namespace	Orientation

Classes
class	AsyncGPUReadbackMatSource
	`AsyncGPUReadback`-backed MatSourceBase that implements IUnityTextureMatSource. More...

class	AsyncGPUReadbackSourceInspectorSettings
	Unity-serializable source inspector settings for AsyncGPUReadbackToMatHelper. More...

class	AsyncGPUReadbackToMatHelper
	Unity helper that reads Texture sources via `AsyncGPUReadback` and exposes frames through AsyncGPUReadbackMatSource. Primary Unity entry for texture readback; use SourceToMatHelperBase.MatSource for advanced access; use MultiSourceToMatHelper to switch helper kinds. More...

class	DerivedFrameInspectorGroup
	Inspector foldout grouping derived frame settings and layout-changed event wiring. More...

class	DerivedFrameInspectorSettings
	Unity-serializable derived frame settings for SourceToMatHelperBase. More...

class	DerivedFrameLayoutChangedUnityEvent
	UnityEvent invoked when a derived frame layout changes after initialization. More...

class	ErrorEventsInspectorGroup
	Inspector foldout grouping error UnityEvents for SourceToMatHelperBase. More...

class	FrameEventsInspectorGroup
	Inspector foldout grouping frame delivery UnityEvents for SourceToMatHelperBase. More...

interface	ICameraFacingToMatHelperControls
	Helper-facing controls for front or back camera facing selection. Custom camera helpers that support facing should implement this so UI and tools can change the request through the helper public API (not by writing `MatSource` directly). More...

interface	ICameraToMatHelperControls
	Helper-facing controls for camera sources (device, resolution, and FPS requests). Custom helpers that wrap a camera mat source should implement this so UI and tools can change requests through the helper public API (not by writing `MatSource` directly). Facing selection is provided separately by ICameraFacingToMatHelperControls. More...

interface	IImageFileToMatHelperControls
	Helper-facing controls for image-file sources. Custom helpers that wrap an image-file mat source should implement this so UI and tools can change requests through the helper public API (not by writing `MatSource` directly). More...

class	ImageFileSourceInspectorSettings
	Unity-serializable source inspector settings for ImageFileToMatHelper. More...

class	ImageFileToMatHelper
	Unity helper that loads a still image file via ImageFileFrameGrabber and exposes frames through ImageFileMatSource. Primary Unity entry for image files; use SourceToMatHelperBase.MatSource for advanced access; use MultiSourceToMatHelper to switch helper kinds. More...

interface	IMatUpdateFPSToMatHelperControls
	Helper-facing controls for mat-update FPS throttling on sources without a native frame rate. Custom helpers that expose mat-update FPS should implement this so UI and tools can change the request through the helper public API (not by writing `MatSource` directly). More...

interface	IUnityCameraMatSource
	Unity WebCam device enumeration capabilities for camera IMatSource implementations. More...

interface	IUnityCameraPoseProvider
	Unity camera pose matrices for camera OpenCVForUnity.Extensions.SourceToMat.IMatSource implementations. More...

interface	IUnityCameraToMatHelperControls
	Helper-facing Unity WebCam device enumeration. Optional supplement to ICameraToMatHelperControls when Unity device metadata is available. More...

interface	IUnityTextureMatSource
	Texture-backed IMatSource capabilities for Unity integration helpers. More...

interface	IUnityTextureToMatHelperControls
	Helper-facing controls for Unity texture-backed sources. Custom helpers that wrap a texture mat source should implement this so UI and tools can change the source through the helper public API (not by writing `MatSource` directly). More...

interface	IUnityVideoFileMatSource
	Unity `VideoPlayer`-backed video-file IMatSource capabilities. More...

interface	IVideoFileToMatHelperControls
	Helper-facing controls for video-file sources. Custom helpers that wrap a video-file mat source should implement this so UI and tools can change requests through the helper public API (not by writing `MatSource` directly). More...

class	LifecycleEventsInspectorGroup
	Inspector foldout grouping lifecycle UnityEvents for SourceToMatHelperBase. More...

class	MultiSourcePerKindSettings
	Per-kind inspector setting cache used by MultiSourceToMatHelper when swapping the active child helper (Pull before destroy, Push after add). More...

class	MultiSourceToMatHelper
	Secondary facade that switches the active SourceToMatHelperBase kind on this GameObject. Primary Unity entry remains a concrete `*ToMatHelper`; use ActiveHelper and its SourceToMatHelperBase.MatSource (and capability interfaces) for advanced access. More...

class	SourceToMatCommonInspectorSettings
	Unity-serializable common inspector settings shared by SourceToMatHelperBase and MultiSourceToMatHelper. More...

class	SourceToMatErrorUnityEvent
	UnityEvent carrying a SourceToMatErrorCode and an optional message from SourceToMat helpers. More...

class	SourceToMatHelperBase
	Abstract base for Unity MonoBehaviour helpers that expose a wrapped IMatSource. Primary Unity entry is a concrete `*ToMatHelper`; use MatSource (and capability interfaces) for advanced access; use MultiSourceToMatHelper to switch helper kinds. Does not implement IMatSource; derived helpers own inspector fields and wire a concrete source. More...

class	SourceToMatUnityMainThreadUtils
	Unity-specific SourceToMat integration notes and strict main-thread affinity for Helpers.SourceToMatHelperBase components. More...

class	SourceToMatUnityMetaKeys
	Unity-specific meta property keys for OpenCVForUnity.Extensions.SourceToMat.IMatMetaProperties. More...

class	SourceToMatUnityPath
	Resolves Unity-side file paths for SourceToMat helpers. Accepts a path relative to the `StreamingAssets` folder or an absolute URI/path string, and returns a host-resolved readable path for Extensions grabbers and options. More...

struct	UnityCameraDeviceInfo
	Describes a Unity WebCam device entry for device enumeration. More...

class	UnityVideoPlayerMatSource
	Unity `VideoPlayer`-backed MatSourceBase that implements IUnityVideoFileMatSource. More...

class	UnityVideoPlayerSourceInspectorSettings
	Unity-serializable source inspector settings for UnityVideoPlayerToMatHelper. More...

class	UnityVideoPlayerToMatHelper
	Unity helper that reads video files via `VideoPlayer` and exposes frames through UnityVideoPlayerMatSource implementing IUnityVideoFileMatSource. Primary Unity entry for Unity VideoPlayer files; use SourceToMatHelperBase.MatSource for advanced access; use MultiSourceToMatHelper to switch helper kinds. More...

class	VideoCaptureSourceInspectorSettings
	Unity-serializable source inspector settings for VideoCaptureToMatHelper. More...

class	VideoCaptureToMatHelper
	Unity helper that reads video files via OpenCV `VideoCapture` and exposes frames through VideoCaptureMatSource. Primary Unity entry for OpenCV VideoCapture files; use SourceToMatHelperBase.MatSource for advanced access; use MultiSourceToMatHelper to switch helper kinds. More...

class	WebCamTextureMatSource
	Unity `WebCamTexture`-backed MatSourceBase that implements IUnityCameraMatSource, ICameraFacingControllable, and IUnityCameraPoseProvider. More...

class	WebCamTextureSourceInspectorSettings
	Unity-serializable source inspector settings for WebCamTextureToMatHelper. More...

class	WebCamTextureToMatHelper
	Unity helper that reads WebCam frames via `WebCamTexture` and exposes them through WebCamTextureMatSource implementing IUnityCameraMatSource. Primary Unity entry for webcam capture; use SourceToMatHelperBase.MatSource for advanced access; use MultiSourceToMatHelper to switch helper kinds. More...

Enumerations
enum	MultiSourceHelperKind : int { WebCamTexture = 0 , VideoCapture , UnityVideoPlayer , ImageFile , AsyncGPUReadback , Custom }
	Built-in SourceToMatHelperBase kinds that MultiSourceToMatHelper can attach as the single active helper on its GameObject. More...

Enumeration Type Documentation

◆ MultiSourceHelperKind

enum OpenCVForUnity.UnityIntegration.Helper.SourceToMat.MultiSourceHelperKind : int

Built-in SourceToMatHelperBase kinds that MultiSourceToMatHelper can attach as the single active helper on its GameObject.

WebCam Sync and AsyncGPU readback share MultiSourceHelperKind.WebCamTexture; AsyncGPU preference is stored in the WebCam per-kind cache (WebCamTextureSourceInspectorSettings.RequestedUseAsyncGPUReadback) rather than as a separate enum value.

Enumerator
WebCamTexture	WebCamTextureToMatHelper.
VideoCapture	VideoCaptureToMatHelper.
UnityVideoPlayer	UnityVideoPlayerToMatHelper.
ImageFile	ImageFileToMatHelper.
AsyncGPUReadback	AsyncGPUReadbackToMatHelper.
Custom	User-supplied helper component reference on MultiSourceToMatHelper (no per-kind cache DTO).

Namespaces

Classes

Enumerations

Enumeration Type Documentation

◆ MultiSourceHelperKind