Videoquickwritegcf
by Tim C. Lueth, SG-Lib Toolbox: SolidGeometry 5.6 - Video/Audio/PDF
Introduced first in SolidGeometry 5.0, Creation date: 2021-01-11, Last change: 2025-09-15
Simple concept to create videos from figures
Description
CONSIDER USING drawnowvid
This is a simplified concept for the more complex "imageVideo..." functions
Videoquickstart
Videoquickwritetitle
Videoquickwritegcf
Videoquickcloseandopen
See Also: drawnowvid
, Videoquickcloseandopen
, Videoquickwritetextpage
, Videoquickstart
Example Illustration
Syntax
Videoquickwritegcf(vw,[I,n])
Input Parameter
vw: | | video writer |
I: | | Image to write; default is I=getframe(gcf); |
n: | | number of frames; default is 1 |
Copyright 2021-2025 Tim C. Lueth. All rights reserved. The code is the property of Tim C. Lueth and may not be redistributed or modified without explicit written permission. This software may be used free of charge for academic research and teaching purposes only. Commercial use, redistribution, modification, or reverse engineering is strictly prohibited. Access to source code is restricted and granted only under specific agreements. For licensing inquiries or commercial use, please contact: Tim C. Lueth
Algorithm (Workflow)
This function, Videoquickwritegcf, is designed to create video frames from MATLAB figures. It is part of the SG-Library and was introduced in SolidGeometry 5.0. The function is a simplified version of more complex video functions and is used to write frames to a video file.
Input Parameters
- vw: This is the video writer object. It is used to specify the video file to which frames will be written.
- I: This parameter represents the image to be written to the video. If not provided, the default is the current figure frame, obtained using
getframe(gcf).
- n: This is the number of frames to write. The default value is 1.
Function Workflow
- The function begins by retrieving the video writer object
vw from the input arguments. If not provided, it defaults to the global variable Videoquick_vw.
- Next, it retrieves the image
I from the input arguments. If I is not provided or is empty, it defaults to capturing the current figure using getframe(gcf).
- The number of frames
n is then retrieved from the input arguments, defaulting to 1 if not specified.
- Finally, the function calls
imageVideoWrite with the parameters vw, I, and n to write the image to the video file.
The function relies on the helper function getfuncparams to manage input parameters, ensuring defaults are applied when necessary.
Algorithm explaination created using ChatGPT on 2025-08-19 00:08. (Please note: No guarantee for the correctness of this explanation)
Last html export of this page out of FM database by TL: 2025-09-21