figure — Create or select RunMat plotting figures.
figure creates a new plotting figure or selects an existing one as current. RunMat currently encodes graphics handles as host f64 identifiers instead of MATLAB Figure objects; this is a general graphics-representation gap, not numeric MATLAB equivalence. Double numeric selection is the compatibility form, while typed-integer targets, single-precision targets, the 'next' selector, and typed-integer property values are independently gated RunMat-only extensions.
Syntax
fig = figure()
fig = figure(h)
fig = figure(property, value, ...)
fig = figure(h, property, value, ...)Inputs
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
h | NumericScalar | Yes | — | RunMat numeric figure identifier. |
properties | PropertyName | Variadic | — | Figure property/value pairs such as 'Name', 'NumberTitle', 'Visible', 'Position', or 'Color'. |
properties | PropertyName | Variadic | — | Figure property/value pairs to apply after selecting or creating the figure. |
Returns
| Name | Type | Description |
|---|---|---|
fig | NumericScalar | RunMat f64 graphics-handle encoding (not a MATLAB Figure object). |
Errors
| Identifier | When | Message |
|---|---|---|
RunMat:figure:InvalidArgument | Provided figure handle argument is invalid. | figure: invalid argument |
How figure works
figure()creates a new figure and returns RunMat's current hostf64graphics-handle encoding.figure(n)selects figuren. If that handle does not exist yet, RunMat creates it.- In RunMat extension mode,
figure('next')creates a new figure instead of selecting an existing one. - In RunMat extension mode, a positive scalar from any of the eight integer classes is read exactly as a figure identifier and must fit in
u32. - In RunMat extension mode, a positive single-precision scalar can select a figure. Logical and GPU-resident numeric targets reject without provider access.
- Typed-integer values for
Position,Color,NumberTitle,Visible,CurrentAxes, andSgTitleare RunMat-only extensions and are rejected in compatibility mode before graphics state changes. - Integer
Positionvalues cross an explicit hostf64geometry boundary only after every authoritative integer element is proved exactly representable. Integer RGB values are read authoritatively and the normal[0,1]constraint admits only exact zero and one components. - Integer
NumberTitleandVisiblevalues use an exact zero/nonzero predicate with no floating conversion. IntegerCurrentAxesandSgTitlealiases must be exactly representable before lookup in RunMat's currentf64graphics registry. figure('Property', value, ...)creates a fresh figure and applies the requested figure properties.figure(n, 'Property', value, ...)selects or creates figurenand applies the requested figure properties.figure('Position', [left bottom width height])stores MATLAB-style figure window geometry and makes it available throughget(f, 'Position')and figure scene metadata.- The selected figure becomes the target for subsequent plotting commands such as
plot,subplot,gca,clf, andhold.
Options
'Name'sets the figure window name and can be inspected later withget(f, 'Name').'NumberTitle'accepts logical values or MATLAB-style'on'/'off'strings.'Visible'accepts logical values or MATLAB-style'on'/'off'strings. Hidden figures keep their graphics state but do not open or update interactive windows until made visible again.'Position'accepts a finite four-element numeric vector[left bottom width height]; width and height must be positive.'Color'accepts supported color letters, full color names such as'black', or RGB triples, and updates the figure background color.
Does RunMat run figure on the GPU?
figure performs no provider dispatch. GPU-resident arrays passed to later plotting calls may still remain on device when the renderer supports that path.
GPU memory and residency
figure only updates plotting state and returns RunMat's host-side f64 handle encoding. Resident numeric values are not admitted as figure targets and are not gathered.
Examples
Create a fresh figure
f = figure()Expected output:
% f is a positive numeric figure handleSelecting the next available figure
f1 = figure();
f2 = figure("next")Expected output:
% f2 is a different figure handle from f1Select a specific figure handle
figure(3);
plot(1:5, [1 4 2 5 3]);Expected output:
% plotting now targets figure 3Create a named figure with MATLAB-style property pairs
f = figure('Name', 'demo', 'NumberTitle', 'off', 'Visible', 'off');
plot(1:5, [1 4 2 5 3]);Expected output:
% f is a figure handle whose Name, NumberTitle, and Visible properties are setCreate a figure with explicit geometry
f = figure('Position', [100 100 1000 700]);
pos = get(f, 'Position')Expected output:
% pos is [100 100 1000 700]Using figure with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how figure changes the result.
Run a small figure example, explain the result, then change one input and compare the output.
FAQ
Does figure(n) require the handle to exist already?⌄
No. RunMat selects figure n, creating it on demand if necessary.
What does figure('next') do?⌄
In RunMat extension mode it forces creation of a new figure rather than reusing an existing handle. Compatibility mode rejects this selector before changing graphics state.
Can figure set window properties at creation time?⌄
Yes. Pass alternating property/value pairs, either directly or after a numeric handle: figure('Name', 'demo') or figure(3, 'Name', 'demo', 'NumberTitle', 'off').
Does figure draw anything by itself?⌄
No. It only manages the active figure selection. Plotting happens when you call builtins like plot, scatter, or surf.
Why is the returned handle a double scalar?⌄
RunMat's current graphics registry uses a host f64 identifier. MATLAB uses Figure objects, so this representation is tracked as a general graphics-model gap rather than claimed as numeric compatibility.
Can integer, single, logical, or GPU-resident values select a figure?⌄
Host scalar integers and singles are independent RunMat-only extensions. Integers are read from authoritative storage and must be positive u32 values. Logical and resident numeric targets reject.
Can figure property values use typed integers?⌄
Only in RunMat extension mode. Position and graphics-object aliases reject integer values that would round at an f64 boundary, Color accepts only the usual zero/one integer RGB components, and NumberTitle/Visible use exact zero/nonzero tests. These gates run before figure creation, selection, or property mutation.
Related Plotting functions
2D Charts
area · bar · errorbar · heatmap · hist · histogram · loglog · pie · plot · scatter · semilogx · semilogy · stairs · stem
Other
addpoints · ancestor · animatedline · axes · barh · caxis · cla · clf · clim · colorcube · colororder · copyobj · daspect · datacursormode · dataTipTextRow · fcontour · fill · fill3 · findobj · fsurf · gobjects · groot · hgload · hgsave · hidden · histogram2 · hold · line · linkaxes · openfig · opengl · pan · parula · patch · plotmatrix · plotyy · polarhistogram · polarplot · polarscatter · print · quiver3 · ribbon · saveas · savefig · sphere · stackedplot · subtitle · suptitle · text · textscatter · textscatter3 · triplot · waitbar · wordcloud · xlabel · xlim · xline · xscale · xtickangle · xtickformat · xticklabels · xticks · ylabel · ylim · yline · yscale · ytickangle · ytickformat · yticklabels · yticks · zlim · zoom
More plotting resources
Open-source implementation
Unlike proprietary runtimes, every RunMat function is open-source. Read exactly how figure is executed, line by line, in Rust.
- View the source for figure in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is an open-source runtime that executes MATLAB-syntax code blazing on any GPU. It is licensed under the Apache 2.0 license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.