OpenSceneGraph API

osgUtil.RenderStage

osgUtil.RenderStage是OpenSceneGraph的一个实用程序类，提供了在图形渲染阶段对渲染状态进行处理的功能，比如清除屏幕、绘制场景、设置相机、设置光照、设置材质等等。

构造函数

RenderStage();

构造函数用于新建一个RenderStage对象。

成员函数

setCamera

void setCamera(Camera* camera);

设置当前渲染阶段使用的相机对象。

getCamera

Camera* getCamera() const;

获取当前渲染阶段使用的相机对象。

setViewport

void setViewport(osg::Viewport* viewport);

设置当前渲染阶段使用的视口对象。

getViewport

osg::Viewport* getViewport() const;

获取当前渲染阶段使用的视口对象。

setClearMask

void setClearMask(GLbitfield mask);

设置当前渲染阶段清空屏幕时要清空的缓存位掩码。

getClearMask

GLbitfield getClearMask() const;

获取当前渲染阶段清空屏幕时要清空的缓存位掩码。

setClearColor

void setClearColor(const osg::Vec4& color);

设置当前渲染阶段清空屏幕时的颜色。

getClearColor

const osg::Vec4& getClearColor() const;

获取当前渲染阶段清空屏幕时的颜色。

setClearDepth

void setClearDepth(double depth);

设置当前渲染阶段清空屏幕时的深度值。

getClearDepth

double getClearDepth() const;

获取当前渲染阶段清空屏幕时的深度值。

setClearStencil

void setClearStencil(int value);

设置当前渲染阶段清空屏幕时的模板值。

getClearStencil

int getClearStencil() const;

获取当前渲染阶段清空屏幕时的模板值。

setViewportState

void setViewportState(ViewportState* vs);

设置当前渲染阶段使用的ViewportState对象。

getViewportState

ViewportState* getViewportState() const;

获取当前渲染阶段使用的ViewportState对象。

setLightingMode

void setLightingMode(LightingMode mode);

设置当前渲染阶段的光照模式。

光照模式LightingMode包括以下几种：

NO_LIGHT：不使用光照。
HEADLIGHT：使用一个灯光，随相机移动而改变光照方向。
SKY_LIGHT：使用一个天空光，随相机移动而改变光照方向。
LIGHT_INHERITANCE：从当前渲染阶段的前一阶段继承光照设置。

getLightingMode

LightingMode getLightingMode() const;

获取当前渲染阶段的光照模式。

setLight

void setLight(int lightNum, Light* light);

设置当前渲染阶段使用的光源。

参数lightNum表示光源的序号，从0开始，同时也是OpenGL中GL_LIGHT0~GL_LIGHT7的枚举值。

getLight

Light* getLight(int lightNum) const;

获取当前渲染阶段使用的光源。

参数lightNum表示光源的序号，从0开始，同时也是OpenGL中GL_LIGHT0~GL_LIGHT7的枚举值。

setMaterial

void setMaterial(Material* material);

设置当前渲染阶段使用的材质。

getMaterial

Material* getMaterial() const;

获取当前渲染阶段使用的材质。

setClearColorBuffer

void setClearColorBuffer(bool value);

设置当前渲染阶段是否清空颜色缓存。

getClearColorBuffer

bool getClearColorBuffer() const;

获取当前渲染阶段是否清空颜色缓存。

setClearDepthBuffer

void setClearDepthBuffer(bool value);

设置当前渲染阶段是否清空深度缓存。

getClearDepthBuffer

bool getClearDepthBuffer() const;

获取当前渲染阶段是否清空深度缓存。

setClearStencilBuffer

void setClearStencilBuffer(bool value);

设置当前渲染阶段是否清空模板缓存。

getClearStencilBuffer

bool getClearStencilBuffer() const;

获取当前渲染阶段是否清空模板缓存。

setDrawBuffer

void setDrawBuffer(GLenum buffer);

设置当前渲染阶段绘制时使用的颜色缓存。

参数buffer可以是以下值中的一个：

GL_NONE：不绘制到任何缓存。
GL_BACK：绘制到后缓存。
GL_FRONT：绘制到前缓存。
GL_FRONT_AND_BACK：同时绘制到前后两个缓存。

getDrawBuffer

GLenum getDrawBuffer() const;

获取当前渲染阶段绘制时使用的颜色缓存。

setReadBuffer

void setReadBuffer(GLenum buffer);

设置当前渲染阶段读取颜色数据时使用的缓存。

参数buffer可以是以下值中的一个：

GL_NONE：不读取任何缓存。
GL_BACK：读取后缓存。
GL_FRONT：读取前缓存。
GL_FRONT_AND_BACK：同时读取前后两个缓存。
GL_COLOR_ATTACHMENTn：读取指定帧缓冲对象(GL_FRAMEBUFFER）中的颜色附着点n的缓存。
GL_DEPTH_ATTACHMENT：读取指定帧缓冲对象(GL_FRAMEBUFFER）中的深度附着点的缓存。
GL_STENCIL_ATTACHMENT：读取指定帧缓冲对象(GL_FRAMEBUFFER）中的模板附着点的缓存。

getReadBuffer

GLenum getReadBuffer() const;

获取当前渲染阶段读取颜色数据时使用的缓存。

setFrameStamp

void setFrameStamp(FrameStamp* fs);

设置当前渲染阶段的FrameStamp。

FrameStamp是用于帧率控制和时间戳记录的结构体。

getFrameStamp

FrameStamp* getFrameStamp() const;

获取当前渲染阶段的FrameStamp。

draw

void draw(Drawable* drawable, const State& state);

绘制一个可绘制对象。

参数drawable表示要绘制的可绘制对象。

参数state表示渲染状态。

drawInstanced

void drawInstanced(Drawable* drawable, GLint primalCount, const State& state);

绘制多个可绘制对象。

参数drawable表示要绘制的可绘制对象。

参数primalCount表示要绘制的原始图元数。

参数state表示渲染状态。

apply

void apply(View* view, osg::Node* node = nullptr);

根据View和Node来应用当前渲染阶段。

参数view为当前视图。

参数node为当前要绘制的场景节点。

结论

osgUtil.RenderStage提供了对渲染状态进行处理的功能，比如清空屏幕、绘制场景、设置相机、设置光照、设置材质等等。在osgViewer.Viewer的内部实现中，osgUtil.RenderStage也扮演了非常重要的角色。因此深入了解osgUtil.RenderStage的功能和使用，对OpenSceneGraph的学习和使用都是非常有帮助的。