rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / radians.xml
CommitLineData
7faf1d71
AW
1<?xml version="1.0" encoding="UTF-8"?>\r
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
4<refentry id="radians">\r
5 <refmeta>\r
6 <refmetainfo>\r
7 <copyright>\r
8 <year>2011</year>\r
9 <holder>Khronos Group</holder>\r
10 </copyright>\r
11 </refmetainfo>\r
12 <refentrytitle>radians</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>radians</refname>\r
17 <refpurpose>convert a quantity in degrees to radians</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>Declaration</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>genType <function>radians</function></funcdef>\r
23 <paramdef>genType <parameter>degrees</parameter></paramdef>\r
24 </funcprototype>\r
25 </funcsynopsis>\r
26 </refsynopsisdiv>\r
27 <refsect1 id="parameters"><title>Parameters</title>\r
28 <variablelist>\r
29 <varlistentry>\r
30 <term><parameter>degrees</parameter></term>\r
31 <listitem>\r
32 <para>\r
33 Specify the quantity, in degrees, to be converted to radians.\r
34 </para>\r
35 </listitem>\r
36 </varlistentry>\r
37 </variablelist>\r
38 </refsect1>\r
39 <refsect1 id="description"><title>Description</title>\r
40 <para>\r
41 <function>radians</function> converts a quantity, specified in degrees into radians. That is,\r
42 the return value is\r
43 <inlineequation><mml:math>\r
44 <!-- eqn: b sub 0: -->\r
45 <mml:mfrac>\r
46 <mml:mrow>\r
47 <mml:pi /><mml:mo>&sdot;</mml:mo><mml:mi mathvariant="italic">degrees</mml:mi>\r
48 </mml:mrow>\r
49 <mml:mn>180</mml:mn>\r
50 </mml:mfrac>\r
51 </mml:math></inlineequation>.\r
52 </para>\r
53 </refsect1>\r
54 <refsect1 id="versions"><title>Version Support</title>\r
55 <informaltable frame="topbot">\r
56 #VARTABLECOLS#\r
57 <thead>\r
58 #FUNCTABLEHEADER#\r
59 <row>\r
60 <entry>radians</entry>#newin11#\r
61 </row>\r
62 </thead>\r
63 </tgroup>\r
64 </informaltable>\r
65 </refsect1>\r
66 <refsect1 id="seealso"><title>See Also</title>\r
67 <para>\r
68 <citerefentry><refentrytitle>degrees</refentrytitle></citerefentry>,\r
69 </para>\r
70 </refsect1>\r
71 <refsect1 id="Copyright"><title>Copyright</title>\r
72 <para>\r
73 Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
74 This material may be distributed subject to the terms and conditions set forth in \r
75 the Open Publication License, v 1.0, 8 June 1999.\r
76 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
77 </para>\r
78 </refsect1>\r
79</refentry>\r