Difference between revisions of "GLAPI/glDepthRange"

From OpenGL Wiki
Jump to: navigation, search
m (Renaming category: 'GL 4 API Viewport and Clipping' to 'Core API Ref Viewport and Clipping'.)
m (Associated Gets: Direct link to page)
 
(6 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
== Function Definition ==
 
== Function Definition ==
  
   void '''glDepthRange'''(GLclampd ''nearVal'', GLclampd ''farVal'');
+
   void '''glDepthRange'''(GLdouble {{param|nearVal}}, GLdouble {{param|farVal}});
   void '''glDepthRangef'''(GLclampf ''nearVal'', GLclampf ''farVal'');
+
   void '''glDepthRangef'''(GLfloat {{param|nearVal}}, GLfloat {{param|farVal}});
  
 
; nearVal
 
; nearVal
Line 24: Line 24:
 
== Notes ==
 
== Notes ==
  
It is not necessary that ''nearVal'' be less than ''farVal''. Reverse mappings such as ''nearVal'' = 1, and ''farVal'' = 0 are acceptable.
+
It is not necessary that {{param|nearVal}} be less than {{param|farVal}}. Reverse mappings such as ''nearVal'' = 1, and ''farVal'' = 0 are acceptable.
 +
 
 +
The type of the {{param|nearVal}} and {{param|farVal}} parameters was changed from GLclampf to GLfloat for '''glDepthRangef''' and from GLclampd to GLdouble for '''glDepthRange'''. This change is transparent to user code.
  
 
== Associated Gets ==
 
== Associated Gets ==
  
[[GLAPI/glGet|glGet]] with argument {{code|GL_DEPTH_RANGE}}
+
{{enumapifunc|glGet|GL_DEPTH_RANGE}}
  
 
== See Also ==
 
== See Also ==
  
[[GLAPI/glDepthFunc|glDepthFunc]], [[GLAPI/glPolygonOffset|glPolygonOffset]], [[GLAPI/glViewport|glViewport]]
+
{{apifunc|glDepthFunc}}, {{apifunc|glDepthRangeArray}}, {{apifunc|glDepthRangeIndexed}}, {{apifunc|glPolygonOffset}}, {{apifunc|glViewport}}
  
 
== Copyright ==
 
== Copyright ==
Line 38: Line 40:
 
Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/].
 
Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/].
  
[[Category:API Reference 4|DepthRange]]
 
 
[[Category:Core API Ref Viewport and Clipping|DepthRange]]
 
[[Category:Core API Ref Viewport and Clipping|DepthRange]]
 +
[[Category:Core API Reference|DepthRange]]

Latest revision as of 00:07, 8 February 2015

glDepthRange
Core in version 4.6
Core since version 1.0

glDepthRange: specify mapping of depth values from normalized device coordinates to window coordinates

Function Definition

 void glDepthRange(GLdouble nearVal​, GLdouble farVal​);
 void glDepthRangef(GLfloat nearVal​, GLfloat farVal​);
nearVal
Specifies the mapping of the near clipping plane to window coordinates. The initial value is 0.
farVal
Specifies the mapping of the far clipping plane to window coordinates. The initial value is 1.

Description

After clipping and division by w, depth coordinates range from -1 to 1, corresponding to the near and far clipping planes. glDepthRange specifies a linear mapping of the normalized depth coordinates in this range to window depth coordinates. Regardless of the actual depth buffer implementation, window coordinate depth values are treated as though they range from 0 through 1 (like color components). Thus, the values accepted by glDepthRange are both clamped to this range before they are accepted.

The setting of (0,1) maps the near plane to 0 and the far plane to 1. With this mapping, the depth buffer range is fully utilized.

Notes

It is not necessary that nearVal​ be less than farVal​. Reverse mappings such as nearVal = 1, and farVal = 0 are acceptable.

The type of the nearVal​ and farVal​ parameters was changed from GLclampf to GLfloat for glDepthRangef and from GLclampd to GLdouble for glDepthRange. This change is transparent to user code.

Associated Gets

glGet with argument GL_DEPTH_RANGE

See Also

glDepthFunc, glDepthRangeArray, glDepthRangeIndexed, glPolygonOffset, glViewport

Copyright

Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.