aboutsummaryrefslogtreecommitdiff
path: root/nx-X11/extras/ogl-sample/main/doc/man/mangl/standard/viewport.gl
blob: b923cb8e77e1f61e0e00dfc8222ea91f73cd569b (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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
_C_ License Applicability. Except to the extent portions of this file are
_C_ made subject to an alternative license as permitted in the SGI Free
_C_ Software License B, Version 1.1 (the "License"), the contents of this
_C_ file are subject only to the provisions of the License. You may not use
_C_ this file except in compliance with the License. You may obtain a copy
_C_ of the License at Silicon Graphics, Inc., attn: Legal Services, 1600
_C_ Amphitheatre Parkway, Mountain View, CA 94043-1351, or at:
_C_ 
_C_ http://oss.sgi.com/projects/FreeB
_C_ 
_C_ Note that, as provided in the License, the Software is distributed on an
_C_ "AS IS" basis, with ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS
_C_ DISCLAIMED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES AND
_C_ CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A
_C_ PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
_C_ 
_C_ Original Code. The Original Code is: OpenGL Sample Implementation,
_C_ Version 1.2.1, released January 26, 2000, developed by Silicon Graphics,
_C_ Inc. The Original Code is Copyright (c) 1991-2000 Silicon Graphics, Inc.
_C_ Copyright in any portions created by third parties is as indicated
_C_ elsewhere herein. All Rights Reserved.
_C_ 
_C_ Additional Notice Provisions: The application programming interfaces
_C_ established by SGI in conjunction with the Original Code are The
_C_ OpenGL(R) Graphics System: A Specification (Version 1.2.1), released
_C_ April 1, 1999; The OpenGL(R) Graphics System Utility Library (Version
_C_ 1.3), released November 4, 1998; and OpenGL(R) Graphics with the X
_C_ Window System(R) (Version 1.3), released October 19, 1998. This software
_C_ was created using the OpenGL(R) version 1.2.1 Sample Implementation
_C_ published by SGI, but has not been independently verified as being
_C_ compliant with the OpenGL(R) version 1.2.1 Specification.
_C_
_C_ The first character in this file must be an '_'!
_C_ Anything on a line after _C_ is ignored
_define(_filters,eqn)_C_
_C_      eqn is automatically replaced with neqn for nroff
_header(Viewport,set the viewport)
_names(Viewport)
.EQ
delim $$
.EN
.SH PARAMETERS
_phead(_param1 _param2)
Specify the lower left corner of the viewport rectangle,
in pixels. The initial value is (0,0).
_phead(_param3 _param4)
Specify the width and height
of the viewport.
When a GL context is first attached to a window,
_param3 and _param4 are set to the dimensions of that window.
.SH DESCRIPTION
_cmnd specifies the affine transformation of $x$ and $y$ from
normalized device coordinates to window coordinates.
Let ($x sub nd$, $y sub nd$) be normalized device coordinates.
Then the window coordinates ($x sub w$, $y sub w$) are computed as follows:
.sp
.ce
.EQ
x sub w ~=~ ( x sub nd ~+~ 1 ) left ( _eqnparam3 over 2 right ) ~+~ _eqnparam1
.EN
.sp
.ce
.EQ
y sub w ~=~ ( y sub nd ~+~ 1 ) left ( _eqnparam4 over 2 right ) ~+~ _eqnparam2
.EN
.RE
.P
Viewport width and height are silently clamped
to a range that depends on the implementation.
To query this range, call _cmnd(Get) with argument
_const(MAX_VIEWPORT_DIMS).
.SH ERRORS
_const(INVALID_VALUE) is generated if either _param3 or _param4 is negative.
.P
_const(INVALID_OPERATION) is generated if _cmnd
is executed between the execution of _cmnd(Begin)
and the corresponding execution of _cmnd(End).
.bp
.SH ASSOCIATED GETS
_cmnd(Get) with argument _const(VIEWPORT)
.br
_cmnd(Get) with argument _const(MAX_VIEWPORT_DIMS)
.SH SEE ALSO
_cmnd(DepthRange)