← 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/gethistogramparameter.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/gethistogramparameter.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,tbl)_C_
 
36
_header(GetHistogramParameter,get histogram parameters)
 
37
_names(GetHistogramParameter,[fi]v)
 
38
_define(@<__target>@,@<_param1>@)_C_
 
39
_define(@<__pname>@,@<_param2>@)_C_
 
40
_define(@<__params>@,@<_param3>@)_C_
 
41
.SH PARAMETERS
 
42
_phead(__target)
 
43
Must be one of
 
44
_const(HISTOGRAM) or
 
45
_const(PROXY_HISTOGRAM).
 
46
_phead(__pname)
 
47
The name of the parameter to be retrieved.
 
48
Must be one of
 
49
_const(HISTOGRAM_WIDTH),
 
50
_const(HISTOGRAM_FORMAT),
 
51
_const(HISTOGRAM_RED_SIZE),
 
52
_const(HISTOGRAM_GREEN_SIZE),
 
53
_const(HISTOGRAM_BLUE_SIZE),
 
54
_const(HISTOGRAM_ALPHA_SIZE),
 
55
_const(HISTOGRAM_LUMINANCE_SIZE), or
 
56
_const(HISTOGRAM_SINK).
 
57
_phead(__params)
 
58
Pointer to storage for the returned values.
 
59
.SH DESCRIPTION
 
60
_cmnd is used to query parameter values for the current histogram or for
 
61
a proxy.  The histogram state information may be queried by calling
 
62
_cmnd(GetHistogramParameter) with a __target of _const(HISTOGRAM) (to
 
63
obtain information for the current histogram table) or
 
64
_const(PROXY_HISTOGRAM) (to obtain information from the most recent
 
65
proxy request) and one of the following values for the __pname argument:
 
66
.P
 
67
.ne
 
68
.TS
 
69
center;
 
70
lb lb
 
71
l l.
 
72
_
 
73
Parameter       Description
 
74
_
 
75
_const(HISTOGRAM_WIDTH) Histogram table width
 
76
_const(HISTOGRAM_FORMAT)        Internal format
 
77
_const(HISTOGRAM_RED_SIZE)      Red component counter size, in bits
 
78
_const(HISTOGRAM_GREEN_SIZE)    Green component counter size, in bits
 
79
.TE
 
80
.bp
 
81
.TS
 
82
center;
 
83
lb lb
 
84
l l.
 
85
_
 
86
Parameter       Description
 
87
_
 
88
_const(HISTOGRAM_BLUE_SIZE)     Blue component counter size, in bits
 
89
_const(HISTOGRAM_ALPHA_SIZE)    Alpha component counter size, in bits
 
90
_const(HISTOGRAM_LUMINANCE_SIZE)        Luminance component counter size, in bits
 
91
_const(HISTOGRAM_SINK)  Value of the \f2sink\fP parameter
 
92
_
 
93
.TE
 
94
 
 
95
.SH NOTES
 
96
_cmnd is present only if _arbstring(imaging) is returned when _cmnd(GetString)
 
97
is called with an argument of _const(EXTENSIONS).
 
98
.SH ERRORS
 
99
_const(INVALID_ENUM) is generated if __target is not one of the allowable
 
100
values.
 
101
.P
 
102
_const(INVALID_ENUM) is generated if __pname is not one of the allowable
 
103
values.
 
104
.P
 
105
_const(INVALID_OPERATION) is generated if _cmnd is executed
 
106
between the execution of _cmnd(Begin) and the corresponding
 
107
execution of _cmnd(End).
 
108
.SH SEE ALSO
 
109
_cmnd(GetHistogram),
 
110
_cmnd(Histogram)