~ubuntu-branches/ubuntu/trusty/khronos-opencl-man/trusty

« back to all changes in this revision

Viewing changes to degrees.xml

  • Committer: Package Import Robot
  • Author(s): Mathieu Malaterre
  • Date: 2013-05-21 18:06:15 UTC
  • Revision ID: package-import@ubuntu.com-20130521180615-6e0s2n3pai95ip2f
Tags: upstream-1.0~svn21772
ImportĀ upstreamĀ versionĀ 1.0~svn21772

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
 
3
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd" [
 
4
<!ENTITY commonFunctionsInc SYSTEM "commonFunctionsInc.xml">
 
5
]>
 
6
 
 
7
<refentry>
 
8
    <refentryinfo>
 
9
        <keywordset>
 
10
            <keyword>degrees</keyword>
 
11
        </keywordset>
 
12
    </refentryinfo>
 
13
 
 
14
    <refmeta>
 
15
        <refentrytitle>degrees</refentrytitle>
 
16
 
 
17
        <refmiscinfo>
 
18
            <copyright>
 
19
                <year>2007-2011</year>
 
20
                <holder>The Khronos Group Inc.
 
21
 Permission is hereby granted, free of charge, to any person obtaining a
 
22
copy of this software and/or associated documentation files (the
 
23
"Materials"), to deal in the Materials without restriction, including
 
24
without limitation the rights to use, copy, modify, merge, publish,
 
25
distribute, sublicense, and/or sell copies of the Materials, and to
 
26
permit persons to whom the Materials are furnished to do so, subject to
 
27
the condition that this copyright notice and permission notice shall be included
 
28
in all copies or substantial portions of the Materials.</holder>
 
29
            </copyright>
 
30
        </refmiscinfo>
 
31
        <manvolnum>3</manvolnum>
 
32
    </refmeta>
 
33
 
 
34
<!-- ================================ SYNOPSIS -->
 
35
 
 
36
    <refnamediv id="degrees">
 
37
        <refname>degrees</refname>
 
38
 
 
39
        <refpurpose>
 
40
            Converts radians to degrees.
 
41
        </refpurpose>
 
42
    </refnamediv>
 
43
 
 
44
    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
 
45
        <funcsynopsis>
 
46
            <funcprototype>
 
47
                <funcdef>
 
48
                    gentype
 
49
                    <function>
 
50
                        degrees
 
51
                    </function>
 
52
                </funcdef>
 
53
                <paramdef>gentype<parameter>radians</parameter></paramdef>
 
54
            </funcprototype>
 
55
        </funcsynopsis>
 
56
    </refsynopsisdiv>
 
57
 
 
58
<!-- ================================ DESCRIPTION  -->
 
59
 
 
60
    <refsect1 id="description"><title>Description</title>
 
61
        <para>Converts <varname>radians</varname> to degrees, i.e. (180 / pi) * <varname>radians</varname>.</para>
 
62
    </refsect1>
 
63
 
 
64
<!-- ================================ NOTES  -->
 
65
 
 
66
    <refsect1 id="notes"><title>Notes</title>
 
67
       &commonFunctionsInc;
 
68
        <para>
 
69
            If extended with
 
70
            <citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>, generic type name
 
71
            <type>gentype</type> may indicate <type>half</type> and <type>half{2|3|4|8|16}</type> as
 
72
            arguments and return values.
 
73
        </para>
 
74
    </refsect1>
 
75
 
 
76
<!-- ================================ EXAMPLE  -->
 
77
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
78
<!--
 
79
    <refsect2 id="example1">
 
80
        <title>
 
81
            Example
 
82
        </title>
 
83
 
 
84
        <informaltable frame="none">
 
85
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
86
                <colspec colname="col1" colnum="1" />
 
87
                <tbody>
 
88
                    <row>
 
89
                        <entry>
 
90
                            Example goes here - it will be set in "code" type with white space preserved.
 
91
                        </entry>
 
92
                    </row>
 
93
                </tbody>
 
94
            </tgroup>
 
95
        </informaltable>
 
96
    </refsect2>
 
97
-->
 
98
 
 
99
<!-- ================================ SPECIFICATION  -->
 
100
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
101
-->
 
102
    <refsect1 id="specification"><title>Specification</title>
 
103
        <para>
 
104
            <imageobject>
 
105
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
106
            </imageobject>
 
107
 
 
108
            <olink uri="commonFunctions">OpenCL Specification</olink>
 
109
        </para>
 
110
    </refsect1>
 
111
 
 
112
<!-- ================================ ALSO SEE  -->
 
113
 
 
114
    <refsect1 id="seealso"><title>Also see</title>
 
115
        <para>
 
116
            <citerefentry href="commonFunctions"><refentrytitle>Common Functions</refentrytitle></citerefentry>,
 
117
            <citerefentry><refentrytitle>radians</refentrytitle></citerefentry>
 
118
        </para>
 
119
    </refsect1>
 
120
 
 
121
<!-- ============================== COPYRIGHT -->
 
122
<!-- Content included from copyright.inc.xsl -->
 
123
 
 
124
    <refsect3 id="Copyright"><title></title>
 
125
        <imageobject>
 
126
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
127
        </imageobject>
 
128
        <para />
 
129
    </refsect3>
 
130
 
 
131
<!-- 17-Oct-2011 -->
 
132
</refentry>
 
133