EZPlot

Undocumented

Customizing The Plot's Appearance

  • Undocumented

  • Undocumented

  • The plot’s gain value, which controls the scale of the y-axis values. The default value of the gain is 1.0f and should always be greater than 0.0f.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float gain;

    Swift

    var gain: Float { get set }

  • The type of plot as specified by the EZPlotType enumeration (i.e. a buffer or rolling plot type).

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) EZPlotType plotType;

    Swift

    var plotType: EZPlotType { get set }

  • A boolean indicating whether or not to fill in the graph. A value of YES will make a filled graph (filling in the space between the x-axis and the y-value), while a value of NO will create a stroked graph (connecting the points along the y-axis).

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL shouldFill;

    Swift

    var shouldFill: Bool { get set }

  • A boolean indicating whether the graph should be rotated along the x-axis to give a mirrored reflection. This is typical for audio plots to produce the classic waveform look. A value of YES will produce a mirrored reflection of the y-values about the x-axis, while a value of NO will only plot the y-values.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL shouldMirror;

    Swift

    var shouldMirror: Bool { get set }

Clearing The Plot

  • Clears all data from the audio plot (includes both EZPlotTypeBuffer and EZPlotTypeRolling)

    Declaration

    Objective-C

    - (void)clear;

    Swift

    func clear()

Updating The Plot

  • Updates the plot with the new buffer data and tells the view to redraw itself. Caller will provide a float array with the values they expect to see on the y-axis. The plot will internally handle mapping the x-axis and y-axis to the current view port, any interpolation for fills effects, and mirroring. - parameter: buffer A float array of values to map to the y-axis. - parameter: bufferSize The size of the float array that will be mapped to the y-axis. - warning: The bufferSize is expected to be the same, constant value once initial triggered. For plots using OpenGL a vertex buffer object will be allocated with a maximum buffersize of (2 * the initial given buffer size) to account for any interpolation necessary for filling in the graph. Updates use the glBufferSubData(…) function, which will crash if the buffersize exceeds the initial maximum allocated size.

    Declaration

    Objective-C

    - (void)updateBuffer:(float *)buffer withBufferSize:(UInt32)bufferSize;

    Swift

    func updateBuffer(_ buffer: UnsafeMutablePointer

    Parameters

    buffer

    A float array of values to map to the y-axis.
    bufferSize

    The size of the float array that will be mapped to the y-axis.