← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/extras/ogl-sample/main/doc/man/mangl/standard/scissor.gl

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/extras/ogl-sample/main/doc/man/mangl/standard/scissor.gl
 
1
_C_ License Applicability. Except to the extent portions of this file are
 
2
_C_ made subject to an alternative license as permitted in the SGI Free
 
3
_C_ Software License B, Version 1.1 (the "License"), the contents of this
 
4
_C_ file are subject only to the provisions of the License. You may not use
 
5
_C_ this file except in compliance with the License. You may obtain a copy
 
6
_C_ of the License at Silicon Graphics, Inc., attn: Legal Services, 1600
 
7
_C_ Amphitheatre Parkway, Mountain View, CA 94043-1351, or at:
 
8
_C_ 
 
9
_C_ http://oss.sgi.com/projects/FreeB
 
10
_C_ 
 
11
_C_ Note that, as provided in the License, the Software is distributed on an
 
12
_C_ "AS IS" basis, with ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS
 
13
_C_ DISCLAIMED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES AND
 
14
_C_ CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A
 
15
_C_ PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
 
16
_C_ 
 
17
_C_ Original Code. The Original Code is: OpenGL Sample Implementation,
 
18
_C_ Version 1.2.1, released January 26, 2000, developed by Silicon Graphics,
 
19
_C_ Inc. The Original Code is Copyright (c) 1991-2000 Silicon Graphics, Inc.
 
20
_C_ Copyright in any portions created by third parties is as indicated
 
21
_C_ elsewhere herein. All Rights Reserved.
 
22
_C_ 
 
23
_C_ Additional Notice Provisions: The application programming interfaces
 
24
_C_ established by SGI in conjunction with the Original Code are The
 
25
_C_ OpenGL(R) Graphics System: A Specification (Version 1.2.1), released
 
26
_C_ April 1, 1999; The OpenGL(R) Graphics System Utility Library (Version
 
27
_C_ 1.3), released November 4, 1998; and OpenGL(R) Graphics with the X
 
28
_C_ Window System(R) (Version 1.3), released October 19, 1998. This software
 
29
_C_ was created using the OpenGL(R) version 1.2.1 Sample Implementation
 
30
_C_ published by SGI, but has not been independently verified as being
 
31
_C_ compliant with the OpenGL(R) version 1.2.1 Specification.
 
32
_C_
 
33
_C_ The first character in this file must be an '_'!
 
34
_C_ Anything on a line after _C_ is ignored
 
35
_define(_filters,eqn)_C_
 
36
_C_      eqn is automatically replaced with neqn for nroff
 
37
_header(Scissor, define the scissor box)
 
38
_names(Scissor)
 
39
.SH PARAMETERS
 
40
_phead(_param1 _param2) 
 
41
Specify the lower left corner of the scissor box.
 
42
Initially (0, 0).
 
43
_phead(_param3 _param4)
 
44
Specify the width and height of the scissor box.
 
45
When a GL context is first attached to a window,
 
46
_param3 and _param4 are set to the dimensions of that window.
 
47
.SH DESCRIPTION
 
48
_cmnd defines a rectangle, called the scissor box,
 
49
in window coordinates.
 
50
The first two arguments,
 
51
_param1 and _param2,
 
52
specify the lower left corner of the box.
 
53
_param3 and _param4 specify the width and height of the box. 
 
54
.P
 
55
To enable and disable the scissor test, call
 
56
_cmnd(Enable) and _cmnd(Disable) with argument
 
57
_const(SCISSOR_TEST). The test is initially disabled. 
 
58
While the test is enabled, only pixels that lie within the scissor box
 
59
can be modified by drawing commands.
 
60
Window coordinates have integer values at the shared corners of
 
61
frame buffer pixels.
 
62
\f7glScissor(0,0,1,1)\fP allows modification of only the lower left
 
63
pixel in the window, and \f7glScissor(0,0,0,0)\fP doesn't allow
 
64
modification of any pixels in the window.  
 
65
.P
 
66
When the scissor test is disabled,
 
67
it is as though the scissor box includes the entire window.
 
68
.SH ERRORS
 
69
_const(INVALID_VALUE) is generated if either _param3 or _param4 is negative.
 
70
.P
 
71
_const(INVALID_OPERATION) is generated if _cmnd
 
72
is executed between the execution of _cmnd(Begin)
 
73
and the corresponding execution of _cmnd(End).
 
74
.bp
 
75
.SH ASSOCIATED GETS
 
76
_cmnd(Get) with argument _const(SCISSOR_BOX)
 
77
.br
 
78
_cmnd(IsEnabled) with argument _const(SCISSOR_TEST)
 
79
.SH SEE ALSO
 
80
_cmnd(Enable),
 
81
_cmnd(Viewport)