reference

This documentation is automatically generated from the openFrameworks source code using doxygen and refers to the most recent release, version 0.12.0.

ofBaseRenderer Class Referenceabstract

The base renderer interface. More...

#include <ofGraphicsBaseTypes.h>

Inheritance diagram for ofBaseRenderer:
ofBaseGLRenderer ofCairoRenderer ofNoopRenderer ofRendererCollection ofGLProgrammableRenderer ofGLRenderer

Public Member Functions

virtual ~ofBaseRenderer ()
 
virtual const std::string & getType ()=0
 Get the string representation of the renderer type.
 
virtual void startRender ()=0
 Starts using this renderer as the rendering surface.
 
virtual void finishRender ()=0
 Stop using this renderer as the rendering surface.
 
virtual void draw (const ofPolyline &poly) const =0
 Draw a polyline with this renderer.
 
virtual void draw (const ofPath &shape) const =0
 Draw a path with this renderer.
 
virtual void draw (const ofPath &shape, float x, float y) const
 Draw a path with this renderer at x and y.
 
virtual void draw (const ofMesh &mesh, ofPolyRenderMode renderType) const
 Draw a mesh with this renderer using the renderType.
 
virtual void draw (const ofMesh &vertexData, ofPolyRenderMode renderType, bool useColors, bool useTextures, bool useNormals) const =0
 Draw a mesh with this renderer.
 
virtual void draw (const of3dPrimitive &model, ofPolyRenderMode renderType) const =0
 Draw a model with this renderer using the renderType.
 
virtual void draw (const ofNode &model) const =0
 Draw a node with this renderer using ofNode::customDraw().
 
virtual void draw (const ofImage &image, float x, float y, float z, float w, float h, float sx, float sy, float sw, float sh) const =0
 Draw an image with this renderer.
 
virtual void draw (const ofFloatImage &image, float x, float y, float z, float w, float h, float sx, float sy, float sw, float sh) const =0
 Draw an image with this renderer.
 
virtual void draw (const ofShortImage &image, float x, float y, float z, float w, float h, float sx, float sy, float sw, float sh) const =0
 Draw an image with this renderer.
 
virtual void draw (const ofBaseVideoDraws &video, float x, float y, float w, float h) const =0
 Draw a video with this renderer.
 
virtual void pushView ()=0
 Push the current viewport into the renderer's viewport stack.
 
virtual void popView ()=0
 Pop the current viewport from the renderer's view stack.
 
virtual void viewport (ofRectangle viewport)=0
 Set this renderer's viewport using a rectangle.
 
virtual void viewport (float x=0, float y=0, float width=-1, float height=-1, bool vflip=true)=0
 Set this renderer's viewport manually using x, y, width, and height.
 
virtual void setupScreenPerspective (float width=-1, float height=-1, float fov=60, float nearDist=0, float farDist=0)=0
 Setup the renderer to use a perspective matrix.
 
virtual void setupScreenOrtho (float width=-1, float height=-1, float nearDist=-1, float farDist=1)=0
 Setup the renderer to use an orthographic matrix.
 
virtual void setOrientation (ofOrientation orientation, bool vFlip)=0
 set this renderer's orientation.
 
virtual ofRectangle getCurrentViewport () const =0
 Get this renderer's current viewport.
 
virtual ofRectangle getNativeViewport () const =0
 Get this renderer's current native viewport.
 
virtual int getViewportWidth () const =0
 Get the renderer's current viewport width.
 
virtual int getViewportHeight () const =0
 Get the renderer's current viewport width.
 
virtual bool isVFlipped () const =0
 Returns true if the renderer's current viewport is vertically flipped.
 
virtual void setCoordHandedness (ofHandednessType handedness)=0
 Set the coordinate handidness of this renderer.
 
virtual ofHandednessType getCoordHandedness () const =0
 Get the coordinate handidness of this renderer.
 
virtual void pushMatrix ()=0
 Pushes this renderer's matrix stack down by one.
 
virtual void popMatrix ()=0
 Pops this renderer's current matrix stack.
 
virtual glm::mat4 getCurrentMatrix (ofMatrixMode matrixMode_) const =0
 Get this renderer's current matrix for particular a matrix mode.
 
virtual glm::mat4 getCurrentOrientationMatrix () const =0
 Get this renderer's current orientation matrix.
 
virtual void translate (float x, float y, float z=0)=0
 Translate this renderer's current matrix by x, y, and z.
 
virtual void translate (const glm::vec3 &p)=0
 Translate this renderer's current matrix by a point.
 
virtual void scale (float xAmnt, float yAmnt, float zAmnt=1)=0
 Scale this renderer's current matrix by xAmnt, yAmnt, and zAmnt.
 
virtual void rotateDeg (float degrees, float vecX, float vecY, float vecZ)
 Rotate this renderer's current matrix by degrees about a euler.
 
virtual void rotateXDeg (float degrees)
 Rotate this renderer's current matrix by degrees about the x axis.
 
virtual void rotateYDeg (float degrees)
 Rotate this renderer's current matrix by degrees about the y axis.
 
virtual void rotateZDeg (float degrees)
 Rotate this renderer's current matrix by degrees about the z axis.
 
virtual void rotateDeg (float degrees)
 Rotate this renderer's current matrix by degrees about the z axis.
 
virtual void rotateRad (float degrees, float vecX, float vecY, float vecZ)=0
 Rotate this renderer's current matrix by degrees about a euler.
 
virtual void rotateXRad (float degrees)=0
 Rotate this renderer's current matrix by degrees about the x axis.
 
virtual void rotateYRad (float degrees)=0
 Rotate this renderer's current matrix by degrees about the y axis.
 
virtual void rotateZRad (float degrees)=0
 Rotate this renderer's current matrix by degrees about the z axis.
 
virtual void rotateRad (float degrees)=0
 Rotate this renderer's current matrix by degrees about the z axis.
 
virtual void matrixMode (ofMatrixMode mode)=0
 Sets this renderer's current matrix mode.
 
virtual void loadIdentityMatrix (void)=0
 Load this renderer's identity matrix.
 
virtual void loadMatrix (const glm::mat4 &m)=0
 Load a matrix as this renderer's current matrix.
 
virtual void loadMatrix (const float *m)=0
 Load m as this renderer's current matrix.
 
virtual void multMatrix (const glm::mat4 &m)=0
 Multiply this renderer's current matrix by m.
 
virtual void multMatrix (const float *m)=0
 Multiply this renderer's current matrix by m.
 
virtual void loadViewMatrix (const glm::mat4 &m)=0
 Load m into this renderer's matrix stack as a view matrix.
 
virtual void multViewMatrix (const glm::mat4 &m)=0
 Multiply this renderer's view matrix by m.
 
virtual glm::mat4 getCurrentViewMatrix () const =0
 Get this renderer's current view matrix.
 
virtual glm::mat4 getCurrentNormalMatrix () const =0
 Get this renderer's current normal matrix.
 
virtual void bind (const ofCamera &camera, const ofRectangle &viewport)=0
 Bind camera's matrices to this renderer's matrix stack.
 
virtual void unbind (const ofCamera &camera)=0
 Unbind the camera from this renderer.
 
virtual void setupGraphicDefaults ()=0
 setup the default graphics settings for this renderer.
 
virtual void setupScreen ()=0
 setup the default screen settings for this renderer.
 
virtual void setRectMode (ofRectMode mode)=0
 Set this renderer's rect mode.
 
virtual ofRectMode getRectMode ()=0
 Get this renderer's current rect mode.
 
virtual void setFillMode (ofFillFlag fill)=0
 set this renderer's fill flag.
 
virtual ofFillFlag getFillMode ()=0
 Get this renderer's current fill flag.
 
virtual void setLineWidth (float lineWidth)=0
 Set the line width this renderer should use when drawing lines.
 
virtual void setDepthTest (bool depthTest)=0
 Enable/disable depth testing with this renderer.
 
virtual void setBlendMode (ofBlendMode blendMode)=0
 Set this renderer's current blend mode.
 
virtual void setLineSmoothing (bool smooth)=0
 Enable/disable line smoothing for this renderer if it's supported.
 
virtual void setCircleResolution (int res)=0
 Set the resolution to use when drawing ellipses with this renderer.
 
virtual void enableAntiAliasing ()=0
 Enable this renderer to use anti-aliasing if it is supported.
 
virtual void disableAntiAliasing ()=0
 Disable this renderer from using anti-aliasing.
 
virtual void setColor (int r, int g, int b)=0
 Set the global color this renderer will use when drawing.
 
virtual void setColor (int r, int g, int b, int a)=0
 Set the global color this renderer will use when drawing.
 
virtual void setColor (const ofColor &color)=0
 Set the global color this renderer will use when drawing.
 
virtual void setColor (const ofColor &color, int _a)=0
 Set the global color this renderer will use when drawing.
 
virtual void setColor (int gray)=0
 Set the global color this renderer will use when drawing.
 
virtual void setHexColor (int hexColor)=0
 Set the global color this renderer will use when drawing.
 
virtual void setBitmapTextMode (ofDrawBitmapMode mode)=0
 Set this renderer's bitmap text mode.
 
virtual ofColor getBackgroundColor ()=0
 Get this renderer's current background color.
 
virtual void setBackgroundColor (const ofColor &c)=0
 Set this renderer's background color.
 
virtual void background (const ofColor &c)=0
 Immediately paint a background color to the screen.
 
virtual void background (float brightness)=0
 Immediately paint a grayscale background color to the screen.
 
virtual void background (int hexColor, float _a=255.0f)=0
 Immediately paint a grayscale background color to the screen.
 
virtual void background (int r, int g, int b, int a=255)=0
 Immediately paint a background color to the screen.
 
virtual void setBackgroundAuto (bool bManual)=0
 Enable/disable automatic redrawing of the background each frame.
 
virtual bool getBackgroundAuto ()=0
 Get the current auto redraw background setting for this renderer.
 
virtual void clear ()=0
 Clear this renderer's current color and bit depths.
 
virtual void clear (float r, float g, float b, float a=0)=0
 Clear this renderer's color and bit depths and replace them.
 
virtual void clear (float brightness, float a=0)=0
 Clear this renderer's color and bit depths replacing them.
 
virtual void clearAlpha ()=0
 Restore the alpha color to its full opacity value.
 
virtual void drawLine (float x1, float y1, float z1, float x2, float y2, float z2) const =0
 Draw a line between two 3D points.
 
virtual void drawRectangle (float x, float y, float z, float w, float h) const =0
 Draw a rectangle using a 3D point and a width and height.
 
virtual void drawTriangle (float x1, float y1, float z1, float x2, float y2, float z2, float x3, float y3, float z3) const =0
 Draw a triangle using three 3D points.
 
virtual void drawCircle (float x, float y, float z, float radius) const =0
 Draw a circle using a 3D point and a radius.
 
virtual void drawEllipse (float x, float y, float z, float width, float height) const =0
 Draw an ellipse using a 3D point, width, and height.
 
virtual void drawString (std::string text, float x, float y, float z) const =0
 Draw text with this renderer using the current bitmap text mode.
 
virtual void drawString (const ofTrueTypeFont &font, std::string text, float x, float y) const =0
 Draw text with this renderer using an ofTrueType font.
 
virtual ofPathgetPath ()=0
 Get a reference to the path used internally by this renderer.
 
virtual ofStyle getStyle () const =0
 Get this renderer's current style object.
 
virtual void setStyle (const ofStyle &style)=0
 Set this renderer's current style object.
 
virtual void pushStyle ()=0
 Push this renderer's current style into its internal style stack.
 
virtual void popStyle ()=0
 Pop this renderer's current style from its internal style stack.
 
virtual void setCurveResolution (int resolution)=0
 Set the resolution used when drawing curves with this renderer.
 
virtual void setPolyMode (ofPolyWindingMode mode)=0
 Set this renderer's poly winding mode.
 
virtual const of3dGraphicsget3dGraphics () const =0
 Get a const reference of this renderer's 3D graphics object.
 
virtual of3dGraphicsget3dGraphics ()=0
 Get a reference with this renderer's 3D graphics object.
 
virtual void setPlaneResolution (int columns, int rows)
 Set this renderer's plane resolution using column and rows.
 
virtual glm::vec2 getPlaneResolution () const
 Get this renderer's current plane resolution as a 2D vector.
 
virtual void drawPlane (float x, float y, float width, float height) const
 Draw a plane with the renderer using x, y, width, and height.
 
virtual void drawPlane (float x, float y, float z, float width, float height) const
 Draw a plane with the renderer using x, y, z, width, and height.
 
virtual void drawPlane (const glm::vec3 &position, float width, float height) const
 Draw a plane with the renderer using a 3D point, width, and height.
 
virtual void drawPlane (float width, float height) const
 Draw a plane with the renderer at the origin.
 
virtual void setSphereResolution (int res)
 Set the point resolution to use when drawing a sphere with this renderer.
 
virtual int getSphereResolution () const
 Get this renderer's current sphere resolution.
 
virtual void drawSphere (float x, float y, float radius) const
 Draw a sphere with this renderer using x, y, and radius.
 
virtual void drawSphere (float x, float y, float z, float radius) const
 Draw a sphere with this renderer using x, y, z, and radius.
 
virtual void drawSphere (const glm::vec3 &position, float radius) const
 Draw a sphere with this renderer using a position point and radius.
 
virtual void drawSphere (float radius) const
 Draw a sphere with the renderer at the defualt origin using radius.
 
virtual void setIcoSphereResolution (int res)
 Set the point resolution to use when drawing an icosphere with this renderer.
 
virtual int getIcoSphereResolution () const
 Get this renderer's current icosphere resolution.
 
virtual void drawIcoSphere (float x, float y, float z, float radius) const
 Draw an icosphere with this renderer using x, y, and radius.
 
virtual void drawIcoSphere (float x, float y, float radius) const
 Draw an icosphere with this renderer using x, y, and radius.
 
virtual void drawIcoSphere (const glm::vec3 &position, float radius) const
 Draw an icosphere with this renderer using x, y, and radius.
 
virtual void drawIcoSphere (float radius) const
 Draw an icosphere with the renderer at the origin using radius.
 
virtual void setCylinderResolution (int radiusSegments, int heightSegments, int capSegments=2)
 Set this renderer's cylinder resolution.
 
virtual glm::vec3 getCylinderResolution () const
 Get this renderer's cylinder resolution as a 3D vector.
 
virtual void drawCylinder (float x, float y, float radius, float height) const
 Draw a cylinder with this renderer using x, y, radius, and height.
 
virtual void drawCylinder (float x, float y, float z, float radius, float height) const
 Draw a cylinder with this renderer using x, y, z, radius, and height.
 
virtual void drawCylinder (const glm::vec3 &position, float radius, float height) const
 Draw a cylinder with this renderer using position, radius, and height.
 
virtual void drawCylinder (float radius, float height) const
 Draw a cylinder at the origin using radius and height.
 
virtual void setConeResolution (int radiusSegments, int heightSegments, int capSegments=2)
 Set the resolution of a polygonized cone.
 
virtual glm::vec3 getConeResolution () const
 Get this renderer's cone resolution as a 3D vector.
 
virtual void drawCone (float x, float y, float z, float radius, float height) const
 Draw a cone with this renderer using x, y, z, radius, and height.
 
virtual void drawCone (float x, float y, float radius, float height) const
 Draw a cone with this renderer using x, y, z, radius, and height.
 
virtual void drawCone (const glm::vec3 &position, float radius, float height) const
 Draw a cone with this renderer using x, y, z, radius, and height.
 
virtual void drawCone (float radius, float height) const
 Draw a cone at the origin using radius and height.
 
virtual void setBoxResolution (int res)
 Set the resolution this renderer uses when drawing boxes.
 
virtual void setBoxResolution (int resWidth, int resHeight, int resDepth)
 Set the resolution this renderer uses when drawing boxes.
 
virtual glm::vec3 getBoxResolution () const
 Get this renderer's current box resolution as a 3D vector.
 
virtual void drawBox (float x, float y, float z, float width, float height, float depth) const
 Draws a rectangular box using x, y, z, width, height, and depth.
 
virtual void drawBox (float x, float y, float z, float size) const
 Draws a cube using x, y, z, and size. coordinates.
 
virtual void drawBox (const glm::vec3 &position, float width, float height, float depth) const
 Draws a rectangular box using position, width, height and depth.
 
virtual void drawBox (const glm::vec3 &position, float size) const
 Draws a cube with the specified size, starting from the specified position.
 
virtual void drawBox (float size) const
 Draws a cube with the specified size at the origin.
 
virtual void drawBox (float width, float height, float depth) const
 Draws a rectangular box with the specified dimensions, starting from the origin.
 
virtual void drawAxis (float size) const
 Draw the coordinate system's axes with the renderer.
 
virtual void drawGrid (float stepSize, size_t numberOfSteps, bool labels, bool x, bool y, bool z) const
 Draw the coordinate system's axes as a grid with the renderer.
 
virtual void drawGridPlane (float stepSize, size_t numberOfSteps, bool labels) const
 Draw a coordinate system plane using the y and z axes.
 
virtual void drawArrow (const glm::vec3 &start, const glm::vec3 &end, float headSize) const
 Draw an arrow between two 3D points.
 
virtual void drawRotationAxes (float radius, float stripWidth, int circleRes) const
 Draw the coordinate system's axes with the renderer.
 

Detailed Description

The base renderer interface.

Constructor & Destructor Documentation

◆ ~ofBaseRenderer()

virtual ofBaseRenderer::~ofBaseRenderer ( )
inlinevirtual

Member Function Documentation

◆ background() [1/4]

virtual void ofBaseRenderer::background ( const ofColor c)
pure virtual

Immediately paint a background color to the screen.

If automatic background drawing is enabled (which it is by default) this method called from ofApp::setup() will also repaint the background with this color each frame.

Parameters
cThe color to paint the background with.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ background() [2/4]

virtual void ofBaseRenderer::background ( float  brightness)
pure virtual

Immediately paint a grayscale background color to the screen.

If automatic background drawing is enabled (which it is by default) this method called from ofApp::setup() will also repaint the background with this color each frame.

Parameters
brightnessThe grayscale value between 0 and 255 to paint the background with.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ background() [3/4]

virtual void ofBaseRenderer::background ( int  hexColor,
float  _a = 255.0f 
)
pure virtual

Immediately paint a grayscale background color to the screen.

If automatic background drawing is enabled (which it is by default) this method called from ofApp::setup() will also repaint the background with this color each frame.

Parameters
hexColorThe 24-bit hex representation of the color to paint the background with.
_aThe alpha value between 0 and 255 to apply to hexColor when when painting the background.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ background() [4/4]

virtual void ofBaseRenderer::background ( int  r,
int  g,
int  b,
int  a = 255 
)
pure virtual

Immediately paint a background color to the screen.

Parameters
rThe red value between 0 and 255 to use for the background.
gThe green value between 0 and 255 to use for the background.
bThe blue value between 0 and 255 to use for the background.
aThe alpha value between 0 and 255 to use for the background.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ bind()

virtual void ofBaseRenderer::bind ( const ofCamera camera,
const ofRectangle viewport 
)
pure virtual

Bind camera's matrices to this renderer's matrix stack.

Bind's the camera's modelview and projection matrices to this renderer's matrix stack using viewport. Should be followed with a call to unbind().

Parameters
cameraThe camera to bind to this renderer.
viewportThe viewport to use when binding camera to this renderer.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, and ofBaseGLRenderer.

◆ clear() [1/3]

virtual void ofBaseRenderer::clear ( )
pure virtual

Clear this renderer's current color and bit depths.

clear() will clear the screen entirely.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ clear() [2/3]

virtual void ofBaseRenderer::clear ( float  brightness,
float  a = 0 
)
pure virtual

Clear this renderer's color and bit depths replacing them.

clear() will clear the screen entirely.

Parameters
brightnessThe grayscale value between 0 and 255 to use when clearing the screen.
aThe alpha value between 0 and 255 to use when clearing the screen. Defaults to 0.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ clear() [3/3]

virtual void ofBaseRenderer::clear ( float  r,
float  g,
float  b,
float  a = 0 
)
pure virtual

Clear this renderer's color and bit depths and replace them.

clear() will clear the screen entirely.

Parameters
rThe red value between 0 and 255 to use when clearing the screen.
gThe green value between 0 and 255 to use when clearing the screen.
bThe blue value between 0 and 255 use when clearing the screen.
aThe alpha value between 0 and 255 use when clearing the screen. Defaults to 0.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ clearAlpha()

virtual void ofBaseRenderer::clearAlpha ( )
pure virtual

Restore the alpha color to its full opacity value.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ disableAntiAliasing()

virtual void ofBaseRenderer::disableAntiAliasing ( )
pure virtual

Disable this renderer from using anti-aliasing.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ draw() [1/11]

virtual void ofBaseRenderer::draw ( const of3dPrimitive model,
ofPolyRenderMode  renderType 
) const
pure virtual

Draw a model with this renderer using the renderType.

renderType defines how the model will be rendered and may be: OF_MESH_POINTS, OF_MESH_WIREFRAME, OF_MESH_FILL

Parameters
modelThe model to draw with this renderer.
renderTypeThe render mode to use when drawing the model with this renderer.
See also
ofPolyRenderMode

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ draw() [2/11]

virtual void ofBaseRenderer::draw ( const ofBaseVideoDraws video,
float  x,
float  y,
float  w,
float  h 
) const
pure virtual

Draw a video with this renderer.

Parameters
videoThe video with draw with this renderer.
xThe x coordinate to use to draw video with this renderer.
yThe y coordinate to use to draw video with this renderer.
wThe width to use to draw the video with this renderer.
hThe height to use to draw the video with this renderer.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ draw() [3/11]

virtual void ofBaseRenderer::draw ( const ofFloatImage image,
float  x,
float  y,
float  z,
float  w,
float  h,
float  sx,
float  sy,
float  sw,
float  sh 
) const
pure virtual

Draw an image with this renderer.

Parameters
imageThe image to draw with this renderer.
xThe x coordinate to use to draw image with this renderer.
yThe y coordinate to use to draw image with this renderer.
zThe z coordinate to use to draw image with this renderer.
wThe width to use to draw image with this renderer.
hThe height to use to draw image with this renderer.
sxThe subsection x axis offset within the image texture.
syThe subsection y axis offset within the image texture.
swThe subsection width offset within the image texture.
shThe subsection height offset within the image texture.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, and ofRendererCollection.

◆ draw() [4/11]

virtual void ofBaseRenderer::draw ( const ofImage image,
float  x,
float  y,
float  z,
float  w,
float  h,
float  sx,
float  sy,
float  sw,
float  sh 
) const
pure virtual

Draw an image with this renderer.

Parameters
imageThe image to draw with this renderer.
xThe x coordinate to use when drawing image with this renderer.
yThe y coordinate to use to draw image with this renderer.
zThe z coordinate to use to drawing image with this renderer.
wThe width to use to draw the image with this renderer.
hThe height to use to draw the image with this renderer.
sxThe subsection x axis offset within the image texture.
syThe subsection y axis offset within the image texture.
swThe subsection width offset within the image texture.
shThe subsection height offset within the image texture.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, ofCairoRenderer, and ofRendererCollection.

◆ draw() [5/11]

void ofBaseRenderer::draw ( const ofMesh mesh,
ofPolyRenderMode  renderType 
) const
virtual

Draw a mesh with this renderer using the renderType.

renderType defines how the mesh will be rendered and may be: OF_MESH_POINTS, OF_MESH_WIREFRAME, OF_MESH_FILL

Parameters
meshThe mesh to draw with this renderer.
renderTypeThe render mode to use to draw mesh with this renderer.
See also
ofPolyRenderMode

Reimplemented in ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ draw() [6/11]

virtual void ofBaseRenderer::draw ( const ofMesh vertexData,
ofPolyRenderMode  renderType,
bool  useColors,
bool  useTextures,
bool  useNormals 
) const
pure virtual

Draw a mesh with this renderer.

renderType defines how the mesh will be rendered and may be: OF_MESH_POINTS, OF_MESH_WIREFRAME, OF_MESH_FILL

Parameters
vertexDataThe mesh to draw with this renderer.
renderTypeThe render mode to use to draw vertexData to this renderer.
useColorsTrue to use per-vertex coloring to draw the vertexData.
useTexturesTrue to use texture coordinates to draw the vertexData.
useNormalsTrue to use normals to draw the vertexData.
See also
ofPolyRenderMode

Implemented in ofCairoRenderer, ofRendererCollection, ofGLProgrammableRenderer, ofGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ draw() [7/11]

virtual void ofBaseRenderer::draw ( const ofNode model) const
pure virtual

◆ draw() [8/11]

virtual void ofBaseRenderer::draw ( const ofPath shape) const
pure virtual

◆ draw() [9/11]

virtual void ofBaseRenderer::draw ( const ofPath shape,
float  x,
float  y 
) const
inlinevirtual

Draw a path with this renderer at x and y.

Parameters
shapeThe path to draw with this renderer.
xThe x coordinate to use to draw shape.
yThe y coordinate to use to draw shape.

Reimplemented in ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ draw() [10/11]

virtual void ofBaseRenderer::draw ( const ofPolyline poly) const
pure virtual

Draw a polyline with this renderer.

Parameters
polyThe polyline to draw with this renderer.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ draw() [11/11]

virtual void ofBaseRenderer::draw ( const ofShortImage image,
float  x,
float  y,
float  z,
float  w,
float  h,
float  sx,
float  sy,
float  sw,
float  sh 
) const
pure virtual

Draw an image with this renderer.

Parameters
imageThe image to draw with this renderer.
xThe x coordinate to use to draw image with this renderer.
yThe y coordinate to use to draw image with this renderer.
zThe z coordinate to use to draw image with this renderer.
wThe width to use when drawing the image with this renderer.
hThe height to use when drawing the image with this renderer.
sxThe subsection x axis offset within the image texture.
syThe subsection y axis offset within the image texture.
swThe subsection width offset within the image texture.
shThe subsection height offset within the image texture.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, and ofRendererCollection.

◆ drawArrow()

void ofBaseRenderer::drawArrow ( const glm::vec3 &  start,
const glm::vec3 &  end,
float  headSize 
) const
virtual

Draw an arrow between two 3D points.

start The 3D vector to use as the first point.

end The 3D vector to use as the second point. \float headSize The size of the arrowhead.

◆ drawAxis()

void ofBaseRenderer::drawAxis ( float  size) const
virtual

Draw the coordinate system's axes with the renderer.

This draws a red, green, and blue lines for the x, y, and z axes respectively. This can be helpful when trying to orient other objects in respect to the coordinate system.

Parameters
sizeThe length to draw each axis line.

◆ drawBox() [1/6]

void ofBaseRenderer::drawBox ( const glm::vec3 &  position,
float  size 
) const
virtual

Draws a cube with the specified size, starting from the specified position.

A cube is drawn starting from a 3D reference position, with the specified size. The cube is drawn with the current color, e.g. set with ofSetColor(). The cube is drawn filled by default; change this with ofFill().

Parameters
positionan glm::vec3 which contains the (x,y,z) coordinates for the cube's reference corner.
sizeThe size of the cube.

◆ drawBox() [2/6]

void ofBaseRenderer::drawBox ( const glm::vec3 &  position,
float  width,
float  height,
float  depth 
) const
virtual

Draws a rectangular box using position, width, height and depth.

A box is a rectangular solid: an extruded rectangle. It is drawn starting from a 3D reference coordinate. It has a width (in x), a height (in y), and a depth (in z). The box is drawn with the current color, e.g. set with ofSetColor(). The box is drawn filled by default; change this with ofFill();

Parameters
positionan glm::vec3 which contains the (x,y,z) coordinates for the box's reference corner.
widthThe width of the box.
heightThe height of the box.
depthThe depth of the box.

◆ drawBox() [3/6]

void ofBaseRenderer::drawBox ( float  size) const
virtual

Draws a cube with the specified size at the origin.

The cube is drawn with the current color, e.g. set with ofSetColor(). The cube is drawn filled by default; change this with ofFill();

Parameters
sizeThe size of the cube.

◆ drawBox() [4/6]

void ofBaseRenderer::drawBox ( float  width,
float  height,
float  depth 
) const
virtual

Draws a rectangular box with the specified dimensions, starting from the origin.

A box is a rectangular solid: an extruded rectangle. It is drawn starting from the origin of the current reference frame. It has a width (in x), a height (in y), and a depth (in z). The box is drawn with the current color, e.g. set with ofSetColor(). The box is drawn filled by default; change this with ofFill();

Parameters
widthThe width of the box.
heightThe height of the box.
depthThe depth of the box.

◆ drawBox() [5/6]

void ofBaseRenderer::drawBox ( float  x,
float  y,
float  z,
float  size 
) const
virtual

Draws a cube using x, y, z, and size. coordinates.

A cube is a rectangular solid bounded by six square faces of equal size. It is also known as a regular hexahedron, a square parallelepiped, an equilateral cuboid and a right rhombohedron. It is a regular square prism in three orientations.

It is drawn starting from a 3D reference coordinate, with the specified size. The cube is drawn with the current color, e.g. set with ofSetColor(). The cube is drawn filled by default; change this with ofFill().

Parameters
xThe x-coordinate of the cube's origin.
yThe y-coordinate of the cube's origin.
zThe z-coordinate of the cube's origin.
sizeThe size of the cube.

◆ drawBox() [6/6]

void ofBaseRenderer::drawBox ( float  x,
float  y,
float  z,
float  width,
float  height,
float  depth 
) const
virtual

Draws a rectangular box using x, y, z, width, height, and depth.

A box is a rectangular solid: an extruded rectangle. It is drawn starting from a 3D reference coordinate. It has a width (in x), a height (in y), and a depth (in z). The box is drawn with the current color, e.g. set with ofSetColor(). The box is drawn filled by default; change this with ofFill();

Parameters
xThe x-coordinate of the box's origin.
yThe y-coordinate of the box's origin.
zThe z-coordinate of the box's origin.
widthThe width of the box.
heightThe height of the box.
depthThe depth of the box.

◆ drawCircle()

virtual void ofBaseRenderer::drawCircle ( float  x,
float  y,
float  z,
float  radius 
) const
pure virtual

Draw a circle using a 3D point and a radius.

Parameters
xThe x coordinate of the center of the circle.
yThe y coordinate of the center of the circle.
zThe z coordinate of the center of the circle.
radiusThe length of the radius of the circle.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ drawCone() [1/4]

void ofBaseRenderer::drawCone ( const glm::vec3 &  position,
float  radius,
float  height 
) const
virtual

Draw a cone with this renderer using x, y, z, radius, and height.

Cones are drawn with x, y, and z coordinates representing the centroid of the cone. Radius is the radius of the cone's circular footprint and height representing the height of the cone's.

Parameters
positionThe 3D point representing this cone's position.
radiusThe radius to use when drawing this cone's circular footprint.
heightThe height to use when drawing this cone.

◆ drawCone() [2/4]

void ofBaseRenderer::drawCone ( float  radius,
float  height 
) const
virtual

Draw a cone at the origin using radius and height.

This cone will be drawn with its position at the coordinate system's origin. Radius is the radius of the cone's circular footprint and height representing the height of the cone.

Parameters
radiusThe radius to use when drawing this cone's circular footprint.
heightThe height to use when drawing this cone.

◆ drawCone() [3/4]

void ofBaseRenderer::drawCone ( float  x,
float  y,
float  radius,
float  height 
) const
virtual

Draw a cone with this renderer using x, y, z, radius, and height.

Cones are drawn with x, y, and z coordinates representing the centroid of the cylinder. Radius is the radius of the cone's circular footprint and height representing the height of the cone's.

Parameters
xThe x coordinate to use when drawing this cone.
yThe y coordinate to use when drawing this cone.
radiusThe radius to use when drawing this cone's circular footprint.
heightThe height to use when drawing this cone.

◆ drawCone() [4/4]

void ofBaseRenderer::drawCone ( float  x,
float  y,
float  z,
float  radius,
float  height 
) const
virtual

Draw a cone with this renderer using x, y, z, radius, and height.

Cones are drawn with x, y, and z coordinates representing the centroid of the cone. Radius is the radius of the cone's circular footprint and height representing the height of the cone.

Parameters
xThe x coordinate to use when drawing this cone.
yThe y coordinate to use when drawing this cone.
zThe z coordinate to use when drawing this cone.
radiusThe radius to use when drawing this cone's circular footprint.
heightThe height to use when drawing this cone.

◆ drawCylinder() [1/4]

void ofBaseRenderer::drawCylinder ( const glm::vec3 &  position,
float  radius,
float  height 
) const
virtual

Draw a cylinder with this renderer using position, radius, and height.

Cyliners are drawn with x, y, and z coordinates representing the centroid of the cylinder. Radius is the radius of the cylinder's circular footprint and height representing the height of the cylinder.

Parameters
positionThe 3D point to use as a position coordinate when drawing this cylinder.
radiusThe radius to use when drawing this cylinder's circular footprint.
heightThe height to use when drawing this cylinder.

◆ drawCylinder() [2/4]

void ofBaseRenderer::drawCylinder ( float  radius,
float  height 
) const
virtual

Draw a cylinder at the origin using radius and height.

A cylinder drawn in this way will be positioned at the origin. Radius is the radius of the cylinder's circular footprint and height representing the height of the cylinder.

Parameters
radiusThe radius to use when drawing this cylinder's circular footprint.
heightThe height to use when drawing this cylinder.

◆ drawCylinder() [3/4]

void ofBaseRenderer::drawCylinder ( float  x,
float  y,
float  radius,
float  height 
) const
virtual

Draw a cylinder with this renderer using x, y, radius, and height.

Cyliners are drawn with x, y, and z coordinates representing the centroid of the cylinder. Radius is the radius of the cylinder's circular footprint and height representing the height of the cylinder.

Parameters
xThe x coordinate to use when drawing this cylinder.
yThe y coordinate to use when drawing this cylinder.
radiusThe radius to use when drawing this cylinder's circular footprint.
heightThe height to use when drawing this cylinder.

◆ drawCylinder() [4/4]

void ofBaseRenderer::drawCylinder ( float  x,
float  y,
float  z,
float  radius,
float  height 
) const
virtual

Draw a cylinder with this renderer using x, y, z, radius, and height.

Cyliners are drawn with x, y, and z coordinates representing the centroid of the cylinder. Radius is the radius of the cylinder's circular footprint and height representing the height of the cylinder.

Parameters
xThe x coordinate to use when drawing this cylinder.
yThe y coordinate to use when drawing this cylinder.
zThe z coordinate to use when drawing this cylinder.
radiusThe radius to use when drawing this cylinder's circular footprint.
heightThe height to use when drawing this cylinder.

◆ drawEllipse()

virtual void ofBaseRenderer::drawEllipse ( float  x,
float  y,
float  z,
float  width,
float  height 
) const
pure virtual

Draw an ellipse using a 3D point, width, and height.

Parameters
xThe x coordinate of the center of the circle.
yThe y coordinate of the center of the circle.
zThe z coordinate of the center of the circle.
widthThe width of the circle.
heightThe height of the circle.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ drawGrid()

void ofBaseRenderer::drawGrid ( float  stepSize,
size_t  numberOfSteps,
bool  labels,
bool  x,
bool  y,
bool  z 
) const
virtual

Draw the coordinate system's axes as a grid with the renderer.

Parameters
stepSizeThe size of each row/column in each axis grid.
numberOfStepsThe number of rows/columns in each axis grid.
labelsTrue to draw the name and values of the axis as a bitmap string.
xTrue to draw the x axis.
yTrue to draw the y axis.
zTrue to draw the z axis.

◆ drawGridPlane()

void ofBaseRenderer::drawGridPlane ( float  stepSize,
size_t  numberOfSteps,
bool  labels 
) const
virtual

Draw a coordinate system plane using the y and z axes.

Parameters
stepSizeThe size of each row/column on the axis grid.
numberOfStepsThe number of rows/columns on the axis grid.
labelsTrue to draw the names and values of the axes.

◆ drawIcoSphere() [1/4]

void ofBaseRenderer::drawIcoSphere ( const glm::vec3 &  position,
float  radius 
) const
virtual

Draw an icosphere with this renderer using x, y, and radius.

Icospheres are drawn with x, y, and z coordinates representing the center of the icosphere.

Parameters
positionThe 3D position point to use when drawing the icosphere.
radiusThe radius to use when drawing this icosphere.

◆ drawIcoSphere() [2/4]

void ofBaseRenderer::drawIcoSphere ( float  radius) const
virtual

Draw an icosphere with the renderer at the origin using radius.

Parameters
radiusThe radius to use when drawing the icosphere with this renderer.

◆ drawIcoSphere() [3/4]

void ofBaseRenderer::drawIcoSphere ( float  x,
float  y,
float  radius 
) const
virtual

Draw an icosphere with this renderer using x, y, and radius.

Spheres are drawn with x, y, and z coordinates representing the center of the icosphere.

Parameters
xThe x coordinate to use when drawing this icosphere.
yThe y coordinate to use when drawing this icosphere.
radiusThe radius to use when drawing this icosphere.

◆ drawIcoSphere() [4/4]

void ofBaseRenderer::drawIcoSphere ( float  x,
float  y,
float  z,
float  radius 
) const
virtual

Draw an icosphere with this renderer using x, y, and radius.

Spheres are drawn with x, y, and z coordinates representing the center of the icosphere.

Parameters
xThe x coordinate to use when drawing this icosphere.
yThe y coordinate to use when drawing this icosphere.
zThe z coordinate to use when drawing this icosphere.
radiusThe radius to use when drawing this icosphere.

◆ drawLine()

virtual void ofBaseRenderer::drawLine ( float  x1,
float  y1,
float  z1,
float  x2,
float  y2,
float  z2 
) const
pure virtual

Draw a line between two 3D points.

Parameters
x1The x coordinate of the first point.
y1The y coordinate of the first point.
z1The z coordinate of the first point.
x2The x coordinate of the second point.
y2The y coordinate of the second point.
z2The z coordinate of the second point.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ drawPlane() [1/4]

void ofBaseRenderer::drawPlane ( const glm::vec3 &  position,
float  width,
float  height 
) const
virtual

Draw a plane with the renderer using a 3D point, width, and height.

The number of rows and columns this plane will have is dependent on this renderer's current plane resolution set with setPlaneResolution().

Parameters
positionA 3D point to use as the position to draw the plane with this renderer.
widthThe width to use when drawing the plane with this renderer.
heightThe height to use when drawing the plane with this renderer.

◆ drawPlane() [2/4]

void ofBaseRenderer::drawPlane ( float  width,
float  height 
) const
virtual

Draw a plane with the renderer at the origin.

The number of rows and columns this plane will have is dependent on this renderer's current plane resolution set with setPlaneResolution().

Parameters
widthThe width of the plane to use when drawing the plane with this renderer.
heightThe height to use when drawing the plane with this renderer.

◆ drawPlane() [3/4]

void ofBaseRenderer::drawPlane ( float  x,
float  y,
float  width,
float  height 
) const
virtual

Draw a plane with the renderer using x, y, width, and height.

The number of rows and columns this plane will have is dependent on this renderer's current plane resolution set with setPlaneResolution().

Parameters
xThe x coordinate to use when drawing the plane with this renderer.
yThe y coordinate to use when drawing the plane with this renderer.
widthThe width to use when drawing the plane with this renderer.
heightThe height to use when drawing the plane with this renderer.

◆ drawPlane() [4/4]

void ofBaseRenderer::drawPlane ( float  x,
float  y,
float  z,
float  width,
float  height 
) const
virtual

Draw a plane with the renderer using x, y, z, width, and height.

The number of rows and columns this plane will have is dependent on this renderer's current plane resolution set with setPlaneResolution().

Parameters
xThe x coordinate to use when drawing the plane with this renderer.
yThe y coordinate to use when drawing the plane with this renderer.
zThe z coordinate to use when drawing the plane with this renderer.
widthThe width to use when drawing the plane with this renderer.
heightThe height to use when drawing the plane with this renderer.

◆ drawRectangle()

virtual void ofBaseRenderer::drawRectangle ( float  x,
float  y,
float  z,
float  w,
float  h 
) const
pure virtual

Draw a rectangle using a 3D point and a width and height.

Parameters
xThe x coordinate of the rectangle.
yThe y coordinate of the rectangle.
zThe z coordinate of the rectangle.
wThe width of the rectangle.
hThe height of the rectangle.
See also
ofRectMode

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ drawRotationAxes()

void ofBaseRenderer::drawRotationAxes ( float  radius,
float  stripWidth,
int  circleRes 
) const
virtual

Draw the coordinate system's axes with the renderer.

This draws red, green, and blue lines for the x, y, and z rotation axes respectively. This can be helpful when trying to orient other object's rotation in respect to the coordinate system.

Parameters
radiusThe radius to draw the rotation axes with.
stripWidthThe width of each axis line.
circleResThe circle resolution to use when drawing the axes.

◆ drawSphere() [1/4]

void ofBaseRenderer::drawSphere ( const glm::vec3 &  position,
float  radius 
) const
virtual

Draw a sphere with this renderer using a position point and radius.

Spheres are drawn with x, y, and z coordinates representing the center of the sphere.

Parameters
positionThe 3D position point to use when drawing the sphere.
radiusThe radius to use when drawing this sphere.

◆ drawSphere() [2/4]

void ofBaseRenderer::drawSphere ( float  radius) const
virtual

Draw a sphere with the renderer at the defualt origin using radius.

Parameters
radiusThe radius to use when drawing the sphere with this renderer.

◆ drawSphere() [3/4]

void ofBaseRenderer::drawSphere ( float  x,
float  y,
float  radius 
) const
virtual

Draw a sphere with this renderer using x, y, and radius.

Spheres are drawn with x, y, and z coordinates representing the center of the sphere.

Parameters
xThe x coordinate to use when drawing this sphere.
yThe y coordinate to use when drawing this sphere.
radiusThe radius to use when drawing this sphere.

◆ drawSphere() [4/4]

void ofBaseRenderer::drawSphere ( float  x,
float  y,
float  z,
float  radius 
) const
virtual

Draw a sphere with this renderer using x, y, z, and radius.

Spheres are drawn with x, y, and z coordinates representing the center of the sphere.

Parameters
xThe x coordinate to use when drawing this sphere.
yThe y coordinate to use when drawing this sphere.
zThe z coordinate to use when drawing this sphere.
radiusThe radius to use when drawing this sphere.

◆ drawString() [1/2]

virtual void ofBaseRenderer::drawString ( const ofTrueTypeFont font,
std::string  text,
float  x,
float  y 
) const
pure virtual

Draw text with this renderer using an ofTrueType font.

Parameters
fontThe font to use when drawing text.
textThe text to draw with the renderer.
xThe x position for the bottom of text.
yThe y position for the left alignment of text.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ drawString() [2/2]

virtual void ofBaseRenderer::drawString ( std::string  text,
float  x,
float  y,
float  z 
) const
pure virtual

Draw text with this renderer using the current bitmap text mode.

When using the OF_BITMAPMODE_SIMPLE bitmap text strings are drawn with their origin at the bottom left corner of the text. However, setBitmapTextMode() can transform this default behavior with modes like: OF_BITMAPMODE_SIMPLE OF_BITMAPMODE_SCREEN OF_BITMAPMODE_VIEWPORT OF_BITMAPMODE_MODEL OF_BITMAPMODE_MODEL_BILLBOARD

Parameters
textThe text to draw with the renderer.
xThe x position for the bottom of text.
yThe y position for the left alignment of text.
zThe z position of the text.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ drawTriangle()

virtual void ofBaseRenderer::drawTriangle ( float  x1,
float  y1,
float  z1,
float  x2,
float  y2,
float  z2,
float  x3,
float  y3,
float  z3 
) const
pure virtual

Draw a triangle using three 3D points.

Parameters
x1The x coordinate of the first point.
y1The y coordinate of the first point.
z1The z coordinate of the first point.
x2The x coordinate of the second point.
y2The y coordinate of the second point.
z2The z coordinate of the second point.
x3The x coordinate of the third point.
y3The y coordinate of the third point.
z3The z coordinate of the third point.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ enableAntiAliasing()

virtual void ofBaseRenderer::enableAntiAliasing ( )
pure virtual

Enable this renderer to use anti-aliasing if it is supported.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ finishRender()

virtual void ofBaseRenderer::finishRender ( )
pure virtual

Stop using this renderer as the rendering surface.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ get3dGraphics() [1/2]

virtual const of3dGraphics & ofBaseRenderer::get3dGraphics ( ) const
pure virtual

Get a const reference of this renderer's 3D graphics object.

Returns
The 3D graphics object currently being used by this renderer.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ get3dGraphics() [2/2]

virtual of3dGraphics & ofBaseRenderer::get3dGraphics ( )
pure virtual

Get a reference with this renderer's 3D graphics object.

Returns
the 3D graphics object currently being used by this renderer.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getBackgroundAuto()

virtual bool ofBaseRenderer::getBackgroundAuto ( )
pure virtual

Get the current auto redraw background setting for this renderer.

Returns
True if this renderer is set to redraw the background each frame.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getBackgroundColor()

virtual ofColor ofBaseRenderer::getBackgroundColor ( )
pure virtual

Get this renderer's current background color.

Returns
This renderer's current background color.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getBoxResolution()

glm::vec3 ofBaseRenderer::getBoxResolution ( ) const
virtual

Get this renderer's current box resolution as a 3D vector.

The returned vector's x, y, and z properties represent this renderer's current resolution width, resolution height, and resolution depth respectively.

Returns
This renderer's current box resolution as a 3D vector.

◆ getConeResolution()

glm::vec3 ofBaseRenderer::getConeResolution ( ) const
virtual

Get this renderer's cone resolution as a 3D vector.

The resulting vector's x, y, and z properties correspond to the radius segments, height segments, and cap segments of this renderer's cone resolution respectively.

Returns
A 3D vector representing this renderer's current cone resolution.

◆ getCoordHandedness()

virtual ofHandednessType ofBaseRenderer::getCoordHandedness ( ) const
pure virtual

Get the coordinate handidness of this renderer.

Possible handednesses include OF_LEFT_HANDED and OF_RIGHT_HANDED. In a left handed coordinate system positive x, y and z axes point right, up and forward, respectively and positive rotation is clockwise about the axis of rotation. In a right handed coordinate system the positive x and y axes point right and up, and the negative z axis points forward and positive rotation is counterclockwise about the axis of rotation.

Returns
The handedness this renderer is using.
See also
http://seanmiddleditch.com/matrices-handedness-pre-and-post-multiplication-row-vs-column-major-and-notations/
https://www.evl.uic.edu/ralph/508S98/coordinates.html

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getCurrentMatrix()

virtual glm::mat4 ofBaseRenderer::getCurrentMatrix ( ofMatrixMode  matrixMode_) const
pure virtual

Get this renderer's current matrix for particular a matrix mode.

Possible matrix modes include: OF_MATRIX_MODELVIEW OF_MATRIX_PROJECTION OF_MATRIX_TEXTURE

Parameters
matrixMode_The matrix mode to get the current matrix of.
Returns
The current matrix specified by matrixMode_
See also
ofMatrixMode

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getCurrentNormalMatrix()

virtual glm::mat4 ofBaseRenderer::getCurrentNormalMatrix ( ) const
pure virtual

Get this renderer's current normal matrix.

Returns
This renderer's current normal matrix.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getCurrentOrientationMatrix()

glm::mat4 ofBaseRenderer::getCurrentOrientationMatrix ( ) const
pure virtual

Get this renderer's current orientation matrix.

Returns
This renderer's current orientation matrix.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getCurrentViewMatrix()

virtual glm::mat4 ofBaseRenderer::getCurrentViewMatrix ( ) const
pure virtual

Get this renderer's current view matrix.

Returns
This renderer's current view matrix.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getCurrentViewport()

virtual ofRectangle ofBaseRenderer::getCurrentViewport ( ) const
pure virtual

Get this renderer's current viewport.

Unlike getNativeViewport(), this method gets this renderer's current viewport with orientation and vertical flipping applied.

Returns
This renderer's viewport as a rectangle.
See also
getNativeViewport()

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getCylinderResolution()

glm::vec3 ofBaseRenderer::getCylinderResolution ( ) const
virtual

Get this renderer's cylinder resolution as a 3D vector.

The resulting vector's x, y, and z properties correspond to the radius segments, height segments, and cap segments of this renderer's cylinder resolution respectively.

Returns
A 3D vector representing this renderer's current cylinder resolution.

◆ getFillMode()

virtual ofFillFlag ofBaseRenderer::getFillMode ( )
pure virtual

Get this renderer's current fill flag.

Possible fill flags include OF_OUTLINE and OF_FILLED.

Returns
The fill flag this render is currently using.
See also
ofFillFlag

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getIcoSphereResolution()

int ofBaseRenderer::getIcoSphereResolution ( ) const
virtual

Get this renderer's current icosphere resolution.

Returns
This renderer's current icosphere resolution.

◆ getNativeViewport()

virtual ofRectangle ofBaseRenderer::getNativeViewport ( ) const
pure virtual

Get this renderer's current native viewport.

Unlike getViewport(), this method gets this renderer's current viewport without orientation and vertical flipping applied.

Returns
This renderer's native viewport as a rectangle.
See also
getViewport()

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getPath()

virtual ofPath & ofBaseRenderer::getPath ( )
pure virtual

Get a reference to the path used internally by this renderer.

Returns
A reference to the path used internally by this renderer.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getPlaneResolution()

glm::vec2 ofBaseRenderer::getPlaneResolution ( ) const
virtual

Get this renderer's current plane resolution as a 2D vector.

The resulting vector's x and y values corresponds to the current column and row resolutions of this renderer's plane resolution respectively.

Returns
A 2D vector representing this renderer's plane resolution in columns and rows.

◆ getRectMode()

virtual ofRectMode ofBaseRenderer::getRectMode ( )
pure virtual

Get this renderer's current rect mode.

Possible rect modes include OF_RECTMODE_CORNER and OF_RECTMODE_CENTER.

Returns
The renderer's current rect mode.
See also
ofRectMode

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getSphereResolution()

int ofBaseRenderer::getSphereResolution ( ) const
virtual

Get this renderer's current sphere resolution.

Returns
This renderer's current sphere resolution.

◆ getStyle()

virtual ofStyle ofBaseRenderer::getStyle ( ) const
pure virtual

Get this renderer's current style object.

Returns
This renderer's current style object.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getType()

virtual const std::string & ofBaseRenderer::getType ( )
pure virtual

Get the string representation of the renderer type.

For example, this method may return "GL", "ProgrammableGL", or another type depending on the renderer being used.

Returns
The string representation of the renderer type.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getViewportHeight()

virtual int ofBaseRenderer::getViewportHeight ( ) const
pure virtual

Get the renderer's current viewport width.

Returns
The renderer's current viewport width.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ getViewportWidth()

virtual int ofBaseRenderer::getViewportWidth ( ) const
pure virtual

Get the renderer's current viewport width.

Returns
The renderer's current viewport width.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ isVFlipped()

virtual bool ofBaseRenderer::isVFlipped ( ) const
pure virtual

Returns true if the renderer's current viewport is vertically flipped.

Returns
True if the renderer's current viewport is vertically flipped.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ loadIdentityMatrix()

virtual void ofBaseRenderer::loadIdentityMatrix ( void  )
pure virtual

Load this renderer's identity matrix.

This identity matrix is an mat4 matrix with 1s on the main diagonal and 0s elsewhere. [ [1, 0, 0, 0], [0, 1, 0, 0], [0, 0, 1, 0], [0, 0, 0, 1] ]

Matrix multiplications using this matrix as the multiplier will yield no change in the multiplicand matrix.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ loadMatrix() [1/2]

virtual void ofBaseRenderer::loadMatrix ( const float *  m)
pure virtual

Load m as this renderer's current matrix.

m can be passed to loadMatrix() in this way from raw data

Parameters
mFloat pointer to an 4x4 matrix.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ loadMatrix() [2/2]

virtual void ofBaseRenderer::loadMatrix ( const glm::mat4 &  m)
pure virtual

Load a matrix as this renderer's current matrix.

Parameters
mThe matrix to load into this renderer.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ loadViewMatrix()

virtual void ofBaseRenderer::loadViewMatrix ( const glm::mat4 &  m)
pure virtual

Load m into this renderer's matrix stack as a view matrix.

Parameters
mThe view matrix to load into this renderer's matrix stack.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ matrixMode()

virtual void ofBaseRenderer::matrixMode ( ofMatrixMode  mode)
pure virtual

Sets this renderer's current matrix mode.

The possible matrix modes include: OF_MATRIX_MODELVIEW OF_MATRIX_PROJECTION OF_MATRIX_TEXTURE

Parameters
modeThe matrix mode this renderer's matrix should use.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ multMatrix() [1/2]

virtual void ofBaseRenderer::multMatrix ( const float *  m)
pure virtual

Multiply this renderer's current matrix by m.

m can be passed to loadMatrix() in this way with raw data

Parameters
mFloat pointer to an mat4 to multiply this renderer's current matrix by.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ multMatrix() [2/2]

virtual void ofBaseRenderer::multMatrix ( const glm::mat4 &  m)
pure virtual

Multiply this renderer's current matrix by m.

Parameters
mThe matrix to multiply this renderer's current matrix by.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ multViewMatrix()

virtual void ofBaseRenderer::multViewMatrix ( const glm::mat4 &  m)
pure virtual

Multiply this renderer's view matrix by m.

Parameters
mThe matrix to multiply this renderer's view matrix by.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ popMatrix()

virtual void ofBaseRenderer::popMatrix ( )
pure virtual

Pops this renderer's current matrix stack.

popMatrix() restores the renderer's matrix to the state it was last saved with with a call to pushMatrix().

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ popStyle()

virtual void ofBaseRenderer::popStyle ( )
pure virtual

Pop this renderer's current style from its internal style stack.

This restores the style that was last saved with pushStyle().

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ popView()

virtual void ofBaseRenderer::popView ( )
pure virtual

Pop the current viewport from the renderer's view stack.

popView() restores the renderer's viewport to the state it was last saved with with a call to pushView().

See also
viewport()

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ pushMatrix()

virtual void ofBaseRenderer::pushMatrix ( )
pure virtual

Pushes this renderer's matrix stack down by one.

pushMatrix() saves the renderer's current matrix allowing new transformations and scales to effect only the new matrix created by this method. Should be paired with a call to popMatrix().

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ pushStyle()

virtual void ofBaseRenderer::pushStyle ( )
pure virtual

Push this renderer's current style into its internal style stack.

This creates a new style object used by this renderer internally until popStyle() is called.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ pushView()

virtual void ofBaseRenderer::pushView ( )
pure virtual

Push the current viewport into the renderer's viewport stack.

pushViewport() save the current viewport to the renderer's viewport history stack allowing new viewport operations to effect only the new viewport created by this method. Should be paired with popView.

See also
viewport()

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ rotateDeg() [1/2]

void ofBaseRenderer::rotateDeg ( float  degrees)
virtual

Rotate this renderer's current matrix by degrees about the z axis.

This method is an alias of rotateZ().

Parameters
degreesDegrees to rotate about the z axis.
See also
rotateZ()

Reimplemented in ofRendererCollection, and ofGLRenderer.

◆ rotateDeg() [2/2]

void ofBaseRenderer::rotateDeg ( float  degrees,
float  vecX,
float  vecY,
float  vecZ 
)
virtual

Rotate this renderer's current matrix by degrees about a euler.

Parameters
degreesDegrees to rotate about vecX, vecY, and vecZ.
vecXThe x axis to rotate about.
vecYThe y axis to rotate about.
vecZThe z axis to rotate about.

Reimplemented in ofRendererCollection, and ofGLRenderer.

◆ rotateRad() [1/2]

virtual void ofBaseRenderer::rotateRad ( float  degrees)
pure virtual

Rotate this renderer's current matrix by degrees about the z axis.

This method is an alias of rotateZ().

Parameters
degreesDegrees to rotate about the z axis.
See also
rotateZ()

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ rotateRad() [2/2]

virtual void ofBaseRenderer::rotateRad ( float  degrees,
float  vecX,
float  vecY,
float  vecZ 
)
pure virtual

Rotate this renderer's current matrix by degrees about a euler.

Parameters
degreesDegrees to rotate about vecX, vecY, and vecZ.
vecXThe x axis to rotate about.
vecYThe y axis to rotate about.
vecZThe z axis to rotate about.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ rotateXDeg()

void ofBaseRenderer::rotateXDeg ( float  degrees)
virtual

Rotate this renderer's current matrix by degrees about the x axis.

Parameters
degreesDegrees to rotate about the x axis.

Reimplemented in ofRendererCollection, and ofGLRenderer.

◆ rotateXRad()

virtual void ofBaseRenderer::rotateXRad ( float  degrees)
pure virtual

Rotate this renderer's current matrix by degrees about the x axis.

Parameters
degreesDegrees to rotate about the x axis.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ rotateYDeg()

void ofBaseRenderer::rotateYDeg ( float  degrees)
virtual

Rotate this renderer's current matrix by degrees about the y axis.

Parameters
degreesDegrees to rotate about the y axis.

Reimplemented in ofRendererCollection, and ofGLRenderer.

◆ rotateYRad()

virtual void ofBaseRenderer::rotateYRad ( float  degrees)
pure virtual

Rotate this renderer's current matrix by degrees about the y axis.

Parameters
degreesDegrees to rotate about the y axis.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ rotateZDeg()

void ofBaseRenderer::rotateZDeg ( float  degrees)
virtual

Rotate this renderer's current matrix by degrees about the z axis.

Parameters
degreesDegrees to rotate about the z axis.

Reimplemented in ofRendererCollection, and ofGLRenderer.

◆ rotateZRad()

virtual void ofBaseRenderer::rotateZRad ( float  degrees)
pure virtual

Rotate this renderer's current matrix by degrees about the z axis.

Parameters
degreesDegrees to rotate about the z axis.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ scale()

virtual void ofBaseRenderer::scale ( float  xAmnt,
float  yAmnt,
float  zAmnt = 1 
)
pure virtual

Scale this renderer's current matrix by xAmnt, yAmnt, and zAmnt.

Parameters
xAmntThe amount to scale this renderer's current matrix's x axis by.
yAmntThe amount to scale this renderer's current matrix's y axis by.
zAmntThe amount to scale this renderer's current matrix's z axis by. Defaults to 1.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setBackgroundAuto()

virtual void ofBaseRenderer::setBackgroundAuto ( bool  bManual)
pure virtual

Enable/disable automatic redrawing of the background each frame.

Parameters
bManualFalse to disable automatic background redrawing.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setBackgroundColor()

virtual void ofBaseRenderer::setBackgroundColor ( const ofColor c)
pure virtual

Set this renderer's background color.

Parameters
cThe color to request this renderer to use.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setBitmapTextMode()

virtual void ofBaseRenderer::setBitmapTextMode ( ofDrawBitmapMode  mode)
pure virtual

Set this renderer's bitmap text mode.

Possible bitmap texture modes include: OF_BITMAPMODE_SIMPLE OF_BITMAPMODE_SCREEN OF_BITMAPMODE_VIEWPORT OF_BITMAPMODE_MODEL OF_BITMAPMODE_MODEL_BILLBOARD

Parameters
modeThe bitmap mode to request this renderer to use.
See also
ofDrawBitmapMode

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setBlendMode()

virtual void ofBaseRenderer::setBlendMode ( ofBlendMode  blendMode)
pure virtual

Set this renderer's current blend mode.

Possible blend modes include:

Rotate this renderer's current matrix by degrees about the z axis.

This method is an alias of rotateZ().

Parameters
degreesDegrees to rotate about the z axis.
See also
rotateZ() OF_BLENDMODE_DISABLED OF_BLENDMODE_ALPHA OF_BLENDMODE_ADD OF_BLENDMODE_SUBTRACT OF_BLENDMODE_MULTIPLY OF_BLENDMODE_SCREEN
Parameters
blendModeThe blend mode to request this renderer to use.
See also
ofBlendMode
https://helpx.adobe.com/photoshop/using/blending-modes.html

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setBoxResolution() [1/2]

void ofBaseRenderer::setBoxResolution ( int  res)
virtual

Set the resolution this renderer uses when drawing boxes.

Parameters
resThe resolution to use for box widths, heights, and depths.

◆ setBoxResolution() [2/2]

void ofBaseRenderer::setBoxResolution ( int  resWidth,
int  resHeight,
int  resDepth 
)
virtual

Set the resolution this renderer uses when drawing boxes.

Parameters
resWidthThe width resolution this renderer uses when drawing boxes.
resHeightThe height resolution this renderer uses when drawing boxes.
resDepthThe depth resolution this renderer uses when drawing boxes.

◆ setCircleResolution()

virtual void ofBaseRenderer::setCircleResolution ( int  res)
pure virtual

Set the resolution to use when drawing ellipses with this renderer.

Parameters
resThe number of points to use when drawing circles and ellipses with this renderer.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofRendererCollection, and ofCairoRenderer.

◆ setColor() [1/5]

virtual void ofBaseRenderer::setColor ( const ofColor color)
pure virtual

Set the global color this renderer will use when drawing.

The renderer will continue using a color set by setColor() until another call to setColor() changes the drawing color.

Parameters
colorThe color to use when drawing.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setColor() [2/5]

virtual void ofBaseRenderer::setColor ( const ofColor color,
int  _a 
)
pure virtual

Set the global color this renderer will use when drawing.

The renderer will continue using a color set by setColor() until another call to setColor() changes the drawing color.

Parameters
colorThe color to use when drawing.
_aThe alpha value between 0 and 255 to use when drawing.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setColor() [3/5]

virtual void ofBaseRenderer::setColor ( int  gray)
pure virtual

Set the global color this renderer will use when drawing.

The renderer will continue using a color set by setColor() until another call to setColor() changes the drawing color.

Parameters
grayThe grayscale value to use when drawing.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setColor() [4/5]

virtual void ofBaseRenderer::setColor ( int  r,
int  g,
int  b 
)
pure virtual

Set the global color this renderer will use when drawing.

The renderer will continue using a color set by setColor() until another call to setColor() changes the drawing color.

Parameters
rThe red value between 0 and 255 to use when drawing.
gThe green value between 0 and 255 to use when drawing.
bThe blue value between 0 and 255 to use when drawing.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setColor() [5/5]

virtual void ofBaseRenderer::setColor ( int  r,
int  g,
int  b,
int  a 
)
pure virtual

Set the global color this renderer will use when drawing.

The renderer will continue using a color set by setColor() until another call to setColor() changes the drawing color.

Parameters
rThe red value between 0 and 255 to use when drawing.
gThe green value between 0 and 255 to use when drawing.
bThe blue value between 0 and 255 to use when drawing.
aThe alpha value between 0 and 255 to use when drawing.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setConeResolution()

void ofBaseRenderer::setConeResolution ( int  radiusSegments,
int  heightSegments,
int  capSegments = 2 
)
virtual

Set the resolution of a polygonized cone.

Allows you to set the polygonization resolution of any cones you subsequently draw with ofDrawCone().

Parameters
radiusSegmentsThe number of facets (subdivisions) around the cone's circular footprint.
heightSegmentsThe number of subdivisions from the cone's top to bottom.
capSegmentsThe number of annular (ring-shaped) subdivisions of the cone's endcap.

◆ setCoordHandedness()

virtual void ofBaseRenderer::setCoordHandedness ( ofHandednessType  handedness)
pure virtual

Set the coordinate handidness of this renderer.

Possible handednesses include OF_LEFT_HANDED and OF_RIGHT_HANDED. In a left handed coordinate system positive x, y and z axes point right, up and forward, respectively and positive rotation is clockwise about the axis of rotation. In a right handed coordinate system the positive x and y axes point right and up, and the negative z axis points forward and positive rotation is counterclockwise about the axis of rotation.

Parameters
handednessThe handedness to set this renderer to use.
See also
http://seanmiddleditch.com/matrices-handedness-pre-and-post-multiplication-row-vs-column-major-and-notations/
https://www.evl.uic.edu/ralph/508S98/coordinates.html

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setCurveResolution()

virtual void ofBaseRenderer::setCurveResolution ( int  resolution)
pure virtual

Set the resolution used when drawing curves with this renderer.

Parameters
resolutionThe resolution to request this renderer to use when drawing curves.

Implemented in ofRendererCollection, ofGLProgrammableRenderer, ofGLRenderer, and ofCairoRenderer.

◆ setCylinderResolution()

void ofBaseRenderer::setCylinderResolution ( int  radiusSegments,
int  heightSegments,
int  capSegments = 2 
)
virtual

Set this renderer's cylinder resolution.

Parameters
radiusSegmentsThe number of facets (subdivisions) around the icosphere's circular footprint. A larger number yields a higher resolution.
heightSegmentsThe number of subdivisions from the cylinder's top to bottom.
capSegmentsThe number of annular (ring-shaped) subdivisions of the cylinder's endcap. Defaults to 2.

◆ setDepthTest()

virtual void ofBaseRenderer::setDepthTest ( bool  depthTest)
pure virtual

Enable/disable depth testing with this renderer.

When depth testing is enabled the order shapes are drawn with the renderer is dependent on their distance from the camera rather than the order their drawing methods were called. This should be enabled when expecting normal behavior when drawing 3D scenes.

Parameters
depthTestTrue to enable depth testing.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setFillMode()

virtual void ofBaseRenderer::setFillMode ( ofFillFlag  fill)
pure virtual

set this renderer's fill flag.

Possible fill flags include OF_OUTLINE and OF_FILLED.

Parameters
fillThe fill flag to request this renderer to use.
See also
ofFillFlag

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setHexColor()

virtual void ofBaseRenderer::setHexColor ( int  hexColor)
pure virtual

Set the global color this renderer will use when drawing.

The renderer will continue using a color set by setColor() until another call to setColor() changes the drawing color.

Parameters
hexColorThe hexidecimal representation of the color to use when drawing.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setIcoSphereResolution()

void ofBaseRenderer::setIcoSphereResolution ( int  res)
virtual

Set the point resolution to use when drawing an icosphere with this renderer.

Parameters
resThe desired icosphere resolution to use with this renderer.

◆ setLineSmoothing()

virtual void ofBaseRenderer::setLineSmoothing ( bool  smooth)
pure virtual

Enable/disable line smoothing for this renderer if it's supported.

Parameters
smoothTrue to enable line smoothing for this renderer if it's supported.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setLineWidth()

virtual void ofBaseRenderer::setLineWidth ( float  lineWidth)
pure virtual

Set the line width this renderer should use when drawing lines.

Parameters
lineWidthThe line width to request this renderer to use.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setOrientation()

virtual void ofBaseRenderer::setOrientation ( ofOrientation  orientation,
bool  vFlip 
)
pure virtual

set this renderer's orientation.

Possible orientation values include: OF_ORIENTATION_DEFAULT OF_ORIENTATION_180 OF_ORIENTATION_90_LEFT OF_ORIENTATION_90_RIGHT OF_ORIENTATION_UNKNOWN

Parameters
orientationThe orientation to use with this renderer.
vFlipTrue if the orientation should be vertically flipped.
See also
ofOrientation

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setPlaneResolution()

void ofBaseRenderer::setPlaneResolution ( int  columns,
int  rows 
)
virtual

Set this renderer's plane resolution using column and rows.

Parameters
columnsThe number of columns to use when drawing planes with this renderer.
rowsThe number of rows to use when drawing planes with this renderer.

◆ setPolyMode()

virtual void ofBaseRenderer::setPolyMode ( ofPolyWindingMode  mode)
pure virtual

Set this renderer's poly winding mode.

Possible poly winding modes include: OF_POLY_WINDING_ODD OF_POLY_WINDING_NONZERO OF_POLY_WINDING_POSITIVE OF_POLY_WINDING_NEGATIVE OF_POLY_WINDING_ABS_GEQ_TWO

Parameters
modeThe poly winding mode to request this renderer to use.
See also
ofPolyWindingMode

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setRectMode()

virtual void ofBaseRenderer::setRectMode ( ofRectMode  mode)
pure virtual

Set this renderer's rect mode.

Possible rect modes include OF_RECTMODE_CORNER and OF_RECTMODE_CENTER.

Parameters
modeThe rect mode to request this renderer to use.
See also
ofRectMode

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setSphereResolution()

void ofBaseRenderer::setSphereResolution ( int  res)
virtual

Set the point resolution to use when drawing a sphere with this renderer.

UV Sphere

Parameters
resThe desired sphere resolution to use with this renderer.

◆ setStyle()

virtual void ofBaseRenderer::setStyle ( const ofStyle style)
pure virtual

Set this renderer's current style object.

Parameters
styleThe style object to set this renderer to use.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setupGraphicDefaults()

virtual void ofBaseRenderer::setupGraphicDefaults ( )
pure virtual

setup the default graphics settings for this renderer.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setupScreen()

virtual void ofBaseRenderer::setupScreen ( )
pure virtual

setup the default screen settings for this renderer.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setupScreenOrtho()

virtual void ofBaseRenderer::setupScreenOrtho ( float  width = -1,
float  height = -1,
float  nearDist = -1,
float  farDist = 1 
)
pure virtual

Setup the renderer to use an orthographic matrix.

Parameters
widthThe width of the desired orthographic matrix. Defaults to -1 setting its width according to the rendering surface's width.
heightThe height of the desired orthographic matrix. Defaults to -1 setting its height according to the rendering surface's height.
nearDistThe near clipping distance to use with the orthographic matrix. Setting this value to 0 uses the defualt near distance. Defaults to 0.
farDistThe far clipping distance to use with the orthographic matrix. Setting this value to 0 uses the defualt near distance. Defaults to 0.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ setupScreenPerspective()

virtual void ofBaseRenderer::setupScreenPerspective ( float  width = -1,
float  height = -1,
float  fov = 60,
float  nearDist = 0,
float  farDist = 0 
)
pure virtual

Setup the renderer to use a perspective matrix.

Parameters
widthThe width of the desired perspective matrix. Defaults to -1 setting its width according to the rendering surface's width.
heightThe height of the desired perspective matrix. Defaults to Defaults to -1 setting its width according to the rendering surface's width.
fovThe field of view to use with the perspective matrix. Defaults to 60.
nearDistThe near clipping distance to use with the perspective matrix. Setting this value to 0 uses the default near distance. Defaults to 0.
farDistThe far clipping distance to use with the perspective matrix. Setting this value to 0 uses the default near distance. Defaults to 0.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ startRender()

virtual void ofBaseRenderer::startRender ( )
pure virtual

Starts using this renderer as the rendering surface.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ translate() [1/2]

virtual void ofBaseRenderer::translate ( const glm::vec3 &  p)
pure virtual

Translate this renderer's current matrix by a point.

Parameters
pThe 3D point to translate this renderer's current matrix by.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ translate() [2/2]

virtual void ofBaseRenderer::translate ( float  x,
float  y,
float  z = 0 
)
pure virtual

Translate this renderer's current matrix by x, y, and z.

Parameters
xThe x coordinate to translate this renderer's current matrix by.
yThe y coordinate to translate this renderer's current matrix by.
zThe z coordinate to translate this renderer's current matrix by. Defaults to 0.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.

◆ unbind()

virtual void ofBaseRenderer::unbind ( const ofCamera camera)
pure virtual

Unbind the camera from this renderer.

Parameters
cameraThe camera to unbind from this renderer.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, and ofBaseGLRenderer.

◆ viewport() [1/2]

virtual void ofBaseRenderer::viewport ( float  x = 0,
float  y = 0,
float  width = -1,
float  height = -1,
bool  vflip = true 
)
pure virtual

Set this renderer's viewport manually using x, y, width, and height.

Parameters
xThe x coordinate of the viewport. Defaults to 0.
yThe y coordinate of the viewport. Defaults to 0.
wThe width of the viewport. Defaults to -1 setting its width according to the rendering surface's width.
hThe height of the viewport. Defaults to -1 setting its height according to the rendering surface's height.

Implemented in ofCairoRenderer, ofGLProgrammableRenderer, ofGLRenderer, and ofRendererCollection.

◆ viewport() [2/2]

virtual void ofBaseRenderer::viewport ( ofRectangle  viewport)
pure virtual

Set this renderer's viewport using a rectangle.

This method uses the ofGetWidth() and ofGetHeight() to set the width and height of the viewport. It also automatically creates near and far clipping planes based on this width and height.

Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.


The documentation for this class was generated from the following files: