visualization_get_frame_period End of trail navigation bar

Table of Contents

visualization_get_frame_rate

Returns the frame rate for the scene.

Syntax

visualization_get_frame_rate(block)  % Return the frame rate for the specific block
visualization_get_frame_rate         % Return the frame rate for the current block

Description

Returns the frame rate in Hz for the scene associated with the current block. This function may only be used with one of the Visualization blocks. It will exit with an error if invoked for any other type of block.

Parameters

block

The handle of a Visualization block for which to return the frame rate, or the path to the block. If this parameter is omitted then the current block as returned by

gcb

MATLAB Command Line

Click to copy the following command line to the clipboard. Then paste it in the MATLAB Command Window:

doc gcb
is used.

Outputs

This function has no outputs.

Examples

        f = visualization_get_frame_rate; % Returns the frame rate in Hz for the current block

See Also

 

navigation bar

Copyright ©2024 Quanser Inc. This page was generated 2024-10-17. Submit feedback to Quanser about this page.

Link to this page.