Skip to content

Commit 8971c63

Browse files
robotdotnet-adminrobotdotnet-admin
committed
CI Website Updates
1 parent 47211ff commit 8971c63

22 files changed

+750
-4782
lines changed

‎api/CSCore.CvSink.html

Lines changed: 121 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ <h5 class="parameters">Parameters</h5>
171171
</tbody>
172172
</table>
173173
<h5 id="CSCore_CvSink__ctor_System_String__remarks">Remarks</h5>
174-
<div class="markdown level1 remarks"><p><a class="xref" href="CSCore.CvSink.html#CSCore_CvSink_GrabFrame_OpenCvSharp_Mat_">GrabFrame(Mat)</a> must be called on the created sink to get
174+
<div class="markdown level1 remarks"><p>GrabFrame must be called on the created sink to get
175175
each new frame</p>
176176
</div>
177177
<h3 id="properties">Properties
@@ -214,7 +214,7 @@ <h5 class="overrides">Overrides</h5>
214214
<a href="https://github.com/robotdotnet/cameraserver/new/master/apiSpec/new?filename=CSCore_CvSink_Enabled.md&amp;value=---%0Auid%3A%20CSCore.CvSink.Enabled%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
215215
</span>
216216
<span class="small pull-right mobile-hide">
217-
<a href="https://github.com/robotdotnet/cameraserver/blob/master/src/FRC.CameraServer/CvSink.cs/#L67">View Source</a>
217+
<a href="https://github.com/robotdotnet/cameraserver/blob/master/src/FRC.CameraServer/CvSink.cs/#L97">View Source</a>
218218
</span>
219219
<a id="CSCore_CvSink_Enabled_" data-uid="CSCore.CvSink.Enabled*"></a>
220220
<h4 id="CSCore_CvSink_Enabled" data-uid="CSCore.CvSink.Enabled">Enabled</h4>
@@ -241,7 +241,7 @@ <h5 class="propertyValue">Property Value</h5>
241241
</tbody>
242242
</table>
243243
<h5 id="CSCore_CvSink_Enabled_remarks">Remarks</h5>
244-
<div class="markdown level1 remarks"><p>Disabling will cause <a class="xref" href="CSCore.CvSink.html#CSCore_CvSink_GrabFrame_OpenCvSharp_Mat_">GrabFrame(Mat)</a> to not return. This can
244+
<div class="markdown level1 remarks"><p>Disabling will cause GrabFrame to not return. This can
245245
be used to save processor resources when frames are not needed</p>
246246
</div>
247247
<h3 id="methods">Methods
@@ -251,7 +251,7 @@ <h3 id="methods">Methods
251251
<a href="https://github.com/robotdotnet/cameraserver/new/master/apiSpec/new?filename=CSCore_CvSink_GetError.md&amp;value=---%0Auid%3A%20CSCore.CvSink.GetError%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
252252
</span>
253253
<span class="small pull-right mobile-hide">
254-
<a href="https://github.com/robotdotnet/cameraserver/blob/master/src/FRC.CameraServer/CvSink.cs/#L55">View Source</a>
254+
<a href="https://github.com/robotdotnet/cameraserver/blob/master/src/FRC.CameraServer/CvSink.cs/#L85">View Source</a>
255255
</span>
256256
<a id="CSCore_CvSink_GetError_" data-uid="CSCore.CvSink.GetError*"></a>
257257
<h4 id="CSCore_CvSink_GetError" data-uid="CSCore.CvSink.GetError">GetError()</h4>
@@ -278,7 +278,7 @@ <h5 class="returns">Returns</h5>
278278
</tbody>
279279
</table>
280280
<h5 id="CSCore_CvSink_GetError_remarks">Remarks</h5>
281-
<div class="markdown level1 remarks"><p>Call if <a class="xref" href="CSCore.CvSink.html#CSCore_CvSink_GrabFrame_OpenCvSharp_Mat_">GrabFrame(Mat)</a> returns 0 to determine what the error is</p>
281+
<div class="markdown level1 remarks"><p>Call if GrabFrame returns 0 to determine what the error is</p>
282282
</div>
283283
<span class="small pull-right mobile-hide">
284284
<span class="divider">|</span>
@@ -289,7 +289,7 @@ <h5 id="CSCore_CvSink_GetError_remarks">Remarks</h5>
289289
</span>
290290
<a id="CSCore_CvSink_GrabFrame_" data-uid="CSCore.CvSink.GrabFrame*"></a>
291291
<h4 id="CSCore_CvSink_GrabFrame_OpenCvSharp_Mat_" data-uid="CSCore.CvSink.GrabFrame(OpenCvSharp.Mat)">GrabFrame(Mat)</h4>
292-
<div class="markdown level1 summary"><p>Wait for the next frame and get the image</p>
292+
<div class="markdown level1 summary"><p>Wait for the next frame and get the image, timing out after 0.225 seconds, returning 0</p>
293293
</div>
294294
<div class="markdown level1 conceptual"></div>
295295
<h5 class="decalaration">Declaration</h5>
@@ -333,6 +333,121 @@ <h5 class="returns">Returns</h5>
333333
</table>
334334
<h5 id="CSCore_CvSink_GrabFrame_OpenCvSharp_Mat__remarks">Remarks</h5>
335335
<div class="markdown level1 remarks"><p>The provided image will have three 3-bit channels stored in BGR order</p>
336+
</div>
337+
<span class="small pull-right mobile-hide">
338+
<span class="divider">|</span>
339+
<a href="https://github.com/robotdotnet/cameraserver/new/master/apiSpec/new?filename=CSCore_CvSink_GrabFrame_OpenCvSharp_Mat_System_Double_.md&amp;value=---%0Auid%3A%20CSCore.CvSink.GrabFrame(OpenCvSharp.Mat%2CSystem.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
340+
</span>
341+
<span class="small pull-right mobile-hide">
342+
<a href="https://github.com/robotdotnet/cameraserver/blob/master/src/FRC.CameraServer/CvSink.cs/#L59">View Source</a>
343+
</span>
344+
<a id="CSCore_CvSink_GrabFrame_" data-uid="CSCore.CvSink.GrabFrame*"></a>
345+
<h4 id="CSCore_CvSink_GrabFrame_OpenCvSharp_Mat_System_Double_" data-uid="CSCore.CvSink.GrabFrame(OpenCvSharp.Mat,System.Double)">GrabFrame(Mat, Double)</h4>
346+
<div class="markdown level1 summary"><p>Wait for the next frame and get the image, timing out after specified seconds</p>
347+
</div>
348+
<div class="markdown level1 conceptual"></div>
349+
<h5 class="decalaration">Declaration</h5>
350+
<div class="codewrapper">
351+
<pre><code class="lang-csharp hljs">public long GrabFrame(Mat image, double timeout)</code></pre>
352+
</div>
353+
<h5 class="parameters">Parameters</h5>
354+
<table class="table table-bordered table-striped table-condensed">
355+
<thead>
356+
<tr>
357+
<th>Type</th>
358+
<th>Name</th>
359+
<th>Description</th>
360+
</tr>
361+
</thead>
362+
<tbody>
363+
<tr>
364+
<td><a class="xref" href="OpenCvSharp.Mat.html">Mat</a></td>
365+
<td><span class="parametername">image</span></td>
366+
<td><p>The <a class="xref" href="OpenCvSharp.Mat.html">Mat</a> to store the image in</p>
367+
</td>
368+
</tr>
369+
<tr>
370+
<td><a class="xref" href="https://msdn.microsoft.com/en-us/library/system.double(v=vs.110).aspx">Double</a></td>
371+
<td><span class="parametername">timeout</span></td>
372+
<td><p>Timeout in seconds</p>
373+
</td>
374+
</tr>
375+
</tbody>
376+
</table>
377+
<h5 class="returns">Returns</h5>
378+
<table class="table table-bordered table-striped table-condensed">
379+
<thead>
380+
<tr>
381+
<th>Type</th>
382+
<th>Description</th>
383+
</tr>
384+
</thead>
385+
<tbody>
386+
<tr>
387+
<td><a class="xref" href="https://msdn.microsoft.com/en-us/library/system.int64(v=vs.110).aspx">Int64</a></td>
388+
<td><p>Frame time, or 0 on error (call <a class="xref" href="CSCore.CvSink.html#CSCore_CvSink_GetError">GetError()</a> to obtain
389+
the error message</p>
390+
</td>
391+
</tr>
392+
</tbody>
393+
</table>
394+
<h5 id="CSCore_CvSink_GrabFrame_OpenCvSharp_Mat_System_Double__remarks">Remarks</h5>
395+
<div class="markdown level1 remarks"><p>The provided image will have three 3-bit channels stored in BGR order.
396+
Upon a timeout, returns 0.</p>
397+
</div>
398+
<span class="small pull-right mobile-hide">
399+
<span class="divider">|</span>
400+
<a href="https://github.com/robotdotnet/cameraserver/new/master/apiSpec/new?filename=CSCore_CvSink_GrabFrameNoTimeout_OpenCvSharp_Mat_.md&amp;value=---%0Auid%3A%20CSCore.CvSink.GrabFrameNoTimeout(OpenCvSharp.Mat)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
401+
</span>
402+
<span class="small pull-right mobile-hide">
403+
<a href="https://github.com/robotdotnet/cameraserver/blob/master/src/FRC.CameraServer/CvSink.cs/#L73">View Source</a>
404+
</span>
405+
<a id="CSCore_CvSink_GrabFrameNoTimeout_" data-uid="CSCore.CvSink.GrabFrameNoTimeout*"></a>
406+
<h4 id="CSCore_CvSink_GrabFrameNoTimeout_OpenCvSharp_Mat_" data-uid="CSCore.CvSink.GrabFrameNoTimeout(OpenCvSharp.Mat)">GrabFrameNoTimeout(Mat)</h4>
407+
<div class="markdown level1 summary"><p>Wait for the next frame and get the image.</p>
408+
</div>
409+
<div class="markdown level1 conceptual"></div>
410+
<h5 class="decalaration">Declaration</h5>
411+
<div class="codewrapper">
412+
<pre><code class="lang-csharp hljs">public long GrabFrameNoTimeout(Mat image)</code></pre>
413+
</div>
414+
<h5 class="parameters">Parameters</h5>
415+
<table class="table table-bordered table-striped table-condensed">
416+
<thead>
417+
<tr>
418+
<th>Type</th>
419+
<th>Name</th>
420+
<th>Description</th>
421+
</tr>
422+
</thead>
423+
<tbody>
424+
<tr>
425+
<td><a class="xref" href="OpenCvSharp.Mat.html">Mat</a></td>
426+
<td><span class="parametername">image</span></td>
427+
<td><p>The <a class="xref" href="OpenCvSharp.Mat.html">Mat</a> to store the image in</p>
428+
</td>
429+
</tr>
430+
</tbody>
431+
</table>
432+
<h5 class="returns">Returns</h5>
433+
<table class="table table-bordered table-striped table-condensed">
434+
<thead>
435+
<tr>
436+
<th>Type</th>
437+
<th>Description</th>
438+
</tr>
439+
</thead>
440+
<tbody>
441+
<tr>
442+
<td><a class="xref" href="https://msdn.microsoft.com/en-us/library/system.int64(v=vs.110).aspx">Int64</a></td>
443+
<td><p>Frame time, or 0 on error (call <a class="xref" href="CSCore.CvSink.html#CSCore_CvSink_GetError">GetError()</a> to obtain
444+
the error message</p>
445+
</td>
446+
</tr>
447+
</tbody>
448+
</table>
449+
<h5 id="CSCore_CvSink_GrabFrameNoTimeout_OpenCvSharp_Mat__remarks">Remarks</h5>
450+
<div class="markdown level1 remarks"><p>The provided image will have three 3-bit channels stored in BGR order</p>
336451
</div>
337452
</article>
338453
</div>

0 commit comments

Comments
 (0)