aboutsummaryrefslogtreecommitdiffstats
path: root/source/lang/api/bitread.rst
blob: 46b44785e3ab43cfd2d8f96977b6a8c933857eaf (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
.. _lang-bitread:

bitRead()
=========

(Macro) Gets the value of a bit in a number.


Syntax
------

``bitRead(x, n)``


Parameters
----------

* **x** the number from which to read the bit.

* **n** which bit to read, starting at 0 for the least-significant
  (rightmost) bit


Value
-----

The value of the bit (0 or 1).


Arduino Compatibility
---------------------

The Maple implementation of ``bitRead`` is compatible with Arduino.


See also
--------


-  :ref:`lang-bit`
-  :ref:`lang-bitwrite`
-  :ref:`lang-bitset`
-  :ref:`lang-bitclear`


.. include:: cc-attribution.txt