OpenCVForUnity.Extensions.SourceToMat.IMatUpdateFPSControllable Interface Reference

Controls how often the output IMatSource.FrameMat is updated while playing, for sources that have no native frame rate (for example still images or arbitrary texture readback). More...

Properties
float	MatUpdateFPS [get]
	Gets the effective frame update rate in frames per second.
float	RequestedMatUpdateFPS [get, set]
	Gets or sets the requested frame update rate in frames per second. Values of 0 or less mean update every tick.

Detailed Description

Controls how often the output IMatSource.FrameMat is updated while playing, for sources that have no native frame rate (for example still images or arbitrary texture readback).

Do not add to MatSourceBase or to camera / video-file sources. Camera sources use ICameraMatSource.RequestedFPS; video sources use IVideoFileMatSource.FPS. Implement on derived mat sources such as ImageFileMatSource that throttle IMatSourceTickable.Tick via FPSThrottle. Integration-layer mat sources that read arbitrary textures without a native frame rate may also implement this interface.

FPS vocabulary:

Term	Used by	Meaning
RequestedMatUpdateFPS / MatUpdateFPS	Sources without a native frame rate (for example still images or texture readback)	Requested / effective tick thinning rate
ICameraMatSource.RequestedFPS / ICameraMatSource.FPS	Camera sources	Requested / device frame rate
IVideoFileMatSource.FPS	Video file sources	File playback frame rate
FPSThrottle	Internal throttling utility	Wall-clock interval helper used by image sources and video grabbers

Property Documentation

MatUpdateFPS

float OpenCVForUnity.Extensions.SourceToMat.IMatUpdateFPSControllable.MatUpdateFPS

get

Gets the effective frame update rate in frames per second.

Implemented in OpenCVForUnity.Extensions.SourceToMat.ImageFileMatSource, and OpenCVForUnity.UnityIntegration.Helper.SourceToMat.AsyncGPUReadbackMatSource.

RequestedMatUpdateFPS

float OpenCVForUnity.Extensions.SourceToMat.IMatUpdateFPSControllable.RequestedMatUpdateFPS

getset

Gets or sets the requested frame update rate in frames per second. Values of 0 or less mean update every tick.

Implemented in OpenCVForUnity.Extensions.SourceToMat.ImageFileMatSource, and OpenCVForUnity.UnityIntegration.Helper.SourceToMat.AsyncGPUReadbackMatSource.

---

The documentation for this interface was generated from the following file:

• OpenCVForUnity/Assets/OpenCVForUnity/Scripts/Extensions/SourceToMat/IMatUpdateFPSControllable.cs