aboutsummaryrefslogtreecommitdiffstats
path: root/source/arduino/bytecast.rst
blob: 348c9fb481193e87c86624f080b3c121085acf4d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
.. highlight:: cpp

.. _arduino-bytecast:

byte() (cast)
=============

Description
-----------

Converts a value to the :ref:`byte <arduino-byte>` data type.

.. note::

   Casting to the byte type is provided for compatibility with
   Arduino.  However, the recommended Maple type for storing an 8-bit
   unsigned integer is ``uint8``. (C and C++ programmers: ``stdint.h``
   is also available).

   In order to cast a variable ``x`` to a ``uint8``, the
   following syntax can be used::

       uint8(x);

Syntax
------

``byte(x)``


Parameters
----------

**x**: a value of any integer type


Returns
-------

The value, converted to a ``byte``.  Note, however, that if the value
is larger than the maximum value you can store in a byte (255), then
the results might be strange and unexpected.


See Also
--------

-  :ref:`arduino-byte`




.. include:: cc-attribution.txt