Yoctopuce Yocto-Display, User Manual

Page: 241 / 424

22. High-level API Reference
www.yoctopuce.com 235
22.3. Display function interface
Yoctopuce display interface has been designed to easily show information and images. The device
provides built-in multi-layer rendering. Layers can be drawn offline, individually, and freely moved on
the display. It can also replay recorded sequences (animations).
In order to use the functions described here, you should include:
js
<script type='text/javascript' src='yocto_display.js'></script>
cpp
#include "yocto_display.h"
m
#import "yocto_display.h"
pas
uses yocto_display;
vb
yocto_display.vb
cs
yocto_display.cs
java
import com.yoctopuce.YoctoAPI.YDisplay;
uwp
import com.yoctopuce.YoctoAPI.YDisplay;
py
from yocto_display import *
php
require_once('yocto_display.php');
es
in HTML: <script src="../../lib/yocto_display.js"></script>
in node.js: require('yoctolib-es2017/yocto_display.js');
Global functions
yFindDisplay( func )
Retrieves a display for a given identifier.
yFindDisplayInContext( yctx , func )
Retrieves a display for a given identifier in a YAPI context.
yFirstDisplay()
Starts the enumeration of displays currently accessible.
yFirstDisplayInContext( yctx )
Starts the enumeration of displays currently accessible.
YDisplay methods
display
→
clearCache()
Invalidates the cache.
display
→
copyLayerContent( srcLayerId , dstLayerId )
Copies the whole content of a layer to another layer.
display
→
describe()
Returns a short text that describes unambiguously the instance of the display in the form
TYPE(NAME)=SERIAL.FUNCTIONID
.
display
→
fade( brightness , duration )
Smoothly changes the brightness of the screen to produce a fade-in or fade-out effect.
display
→
get_advertisedValue()
Returns the current value of the display (no more than 6 characters).
display
→
get_brightness()
Returns the luminosity of the module informative leds (from 0 to 100).
display
→
get_displayHeight()
Returns the display height, in pixels.
display
→
get_displayLayer( layerId )
Returns a YDisplayLayer object that can be used to draw on the specified layer.