This documentation is automatically generated from the openFrameworks source code using doxygen and refers to the most recent release, version 0.12.0.
The base renderer interface. More...
#include <ofGraphicsBaseTypes.h>

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 ofPath & | getPath ()=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 of3dGraphics & | get3dGraphics () const =0 |
Get a const reference of this renderer's 3D graphics object. | |
virtual of3dGraphics & | get3dGraphics ()=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()
|
inlinevirtual |
Member Function Documentation
◆ background() [1/4]
|
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
-
c The color to paint the background with.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ background() [2/4]
|
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
-
brightness The grayscale value between 0 and 255 to paint the background with.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ background() [3/4]
|
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
-
hexColor The 24-bit hex representation of the color to paint the background with. _a The 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]
|
pure virtual |
Immediately paint a background color to the screen.
- Parameters
-
r The red value between 0 and 255 to use for the background. g The green value between 0 and 255 to use for the background. b The blue value between 0 and 255 to use for the background. a The alpha value between 0 and 255 to use for the background.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ bind()
|
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
-
camera The camera to bind to this renderer. viewport The viewport to use when binding camera
to this renderer.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, and ofBaseGLRenderer.
◆ clear() [1/3]
|
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]
|
pure virtual |
Clear this renderer's color and bit depths replacing them.
clear() will clear the screen entirely.
- Parameters
-
brightness The grayscale value between 0 and 255 to use when clearing the screen. a The 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]
|
pure virtual |
Clear this renderer's color and bit depths and replace them.
clear() will clear the screen entirely.
- Parameters
-
r The red value between 0 and 255 to use when clearing the screen. g The green value between 0 and 255 to use when clearing the screen. b The blue value between 0 and 255 use when clearing the screen. a The alpha value between 0 and 255 use when clearing the screen. Defaults to 0.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ clearAlpha()
|
pure virtual |
Restore the alpha color to its full opacity value.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ disableAntiAliasing()
|
pure virtual |
Disable this renderer from using anti-aliasing.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ draw() [1/11]
|
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
-
model The model to draw with this renderer. renderType The 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]
|
pure virtual |
Draw a video
with this renderer.
- Parameters
-
video The video with draw with this renderer. x The x coordinate to use to draw video
with this renderer.y The y coordinate to use to draw video
with this renderer.w The width to use to draw the video with this renderer. h The 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]
|
pure virtual |
Draw an image
with this renderer.
- Parameters
-
image The image to draw with this renderer. x The x coordinate to use to draw image
with this renderer.y The y coordinate to use to draw image
with this renderer.z The z coordinate to use to draw image
with this renderer.w The width to use to draw image
with this renderer.h The height to use to draw image
with this renderer.sx The subsection x axis offset within the image texture. sy The subsection y axis offset within the image texture. sw The subsection width offset within the image texture. sh The subsection height offset within the image texture.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, and ofRendererCollection.
◆ draw() [4/11]
|
pure virtual |
Draw an image
with this renderer.
- Parameters
-
image The image to draw with this renderer. x The x coordinate to use when drawing image
with this renderer.y The y coordinate to use to draw image
with this renderer.z The z coordinate to use to drawing image
with this renderer.w The width to use to draw the image
with this renderer.h The height to use to draw the image
with this renderer.sx The subsection x axis offset within the image texture. sy The subsection y axis offset within the image texture. sw The subsection width offset within the image texture. sh The subsection height offset within the image texture.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, ofCairoRenderer, and ofRendererCollection.
◆ draw() [5/11]
|
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
-
mesh The mesh to draw with this renderer. renderType The 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]
|
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
-
vertexData The mesh to draw with this renderer. renderType The render mode to use to draw vertexData
to this renderer.useColors True to use per-vertex coloring to draw the vertexData
.useTextures True to use texture coordinates to draw the vertexData
.useNormals True 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]
|
pure virtual |
Draw a node with this renderer using ofNode::customDraw().
- Parameters
-
model The node to draw with this renderer.
- See also
- ofNode::customDraw()
Implemented in ofGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, ofGLProgrammableRenderer, ofCairoRenderer, and ofRendererCollection.
◆ draw() [8/11]
|
pure virtual |
Draw a path with this renderer.
- Parameters
-
shape The path to draw with this renderer.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ draw() [9/11]
|
inlinevirtual |
Draw a path with this renderer at x
and y
.
- Parameters
-
shape The path to draw with this renderer. x The x coordinate to use to draw shape
.y The y coordinate to use to draw shape
.
Reimplemented in ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ draw() [10/11]
|
pure virtual |
Draw a polyline with this renderer.
- Parameters
-
poly The polyline to draw with this renderer.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ draw() [11/11]
|
pure virtual |
Draw an image
with this renderer.
- Parameters
-
image The image to draw with this renderer. x The x coordinate to use to draw image
with this renderer.y The y coordinate to use to draw image
with this renderer.z The z coordinate to use to draw image
with this renderer.w The width to use when drawing the image with this renderer. h The height to use when drawing the image with this renderer. sx The subsection x axis offset within the image texture. sy The subsection y axis offset within the image texture. sw The subsection width offset within the image texture. sh The subsection height offset within the image texture.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofBaseGLRenderer, ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, and ofRendererCollection.
◆ drawArrow()
|
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()
|
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
-
size The length to draw each axis line.
◆ drawBox() [1/6]
|
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
-
position an glm::vec3 which contains the (x,y,z) coordinates for the cube's reference corner. size The size of the cube.
◆ drawBox() [2/6]
|
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
-
position an glm::vec3 which contains the (x,y,z) coordinates for the box's reference corner. width The width of the box. height The height of the box. depth The depth of the box.
◆ drawBox() [3/6]
|
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
-
size The size of the cube.
◆ drawBox() [4/6]
|
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
-
width The width of the box. height The height of the box. depth The depth of the box.
◆ drawBox() [5/6]
|
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
-
x The x-coordinate of the cube's origin. y The y-coordinate of the cube's origin. z The z-coordinate of the cube's origin. size The size of the cube.
◆ drawBox() [6/6]
|
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
-
x The x-coordinate of the box's origin. y The y-coordinate of the box's origin. z The z-coordinate of the box's origin. width The width of the box. height The height of the box. depth The depth of the box.
◆ drawCircle()
|
pure virtual |
Draw a circle using a 3D point and a radius.
- Parameters
-
x The x coordinate of the center of the circle. y The y coordinate of the center of the circle. z The z coordinate of the center of the circle. radius The length of the radius of the circle.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ drawCone() [1/4]
|
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
-
position The 3D point representing this cone's position. radius The radius to use when drawing this cone's circular footprint. height The height to use when drawing this cone.
◆ drawCone() [2/4]
|
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
-
radius The radius to use when drawing this cone's circular footprint. height The height to use when drawing this cone.
◆ drawCone() [3/4]
|
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
-
x The x coordinate to use when drawing this cone. y The y coordinate to use when drawing this cone. radius The radius to use when drawing this cone's circular footprint. height The height to use when drawing this cone.
◆ drawCone() [4/4]
|
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
-
x The x coordinate to use when drawing this cone. y The y coordinate to use when drawing this cone. z The z coordinate to use when drawing this cone. radius The radius to use when drawing this cone's circular footprint. height The height to use when drawing this cone.
◆ drawCylinder() [1/4]
|
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
-
position The 3D point to use as a position coordinate when drawing this cylinder. radius The radius to use when drawing this cylinder's circular footprint. height The height to use when drawing this cylinder.
◆ drawCylinder() [2/4]
|
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
-
radius The radius to use when drawing this cylinder's circular footprint. height The height to use when drawing this cylinder.
◆ drawCylinder() [3/4]
|
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
-
x The x coordinate to use when drawing this cylinder. y The y coordinate to use when drawing this cylinder. radius The radius to use when drawing this cylinder's circular footprint. height The height to use when drawing this cylinder.
◆ drawCylinder() [4/4]
|
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
-
x The x coordinate to use when drawing this cylinder. y The y coordinate to use when drawing this cylinder. z The z coordinate to use when drawing this cylinder. radius The radius to use when drawing this cylinder's circular footprint. height The height to use when drawing this cylinder.
◆ drawEllipse()
|
pure virtual |
Draw an ellipse using a 3D point, width, and height.
- Parameters
-
x The x coordinate of the center of the circle. y The y coordinate of the center of the circle. z The z coordinate of the center of the circle. width The width of the circle. height The height of the circle.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ drawGrid()
|
virtual |
Draw the coordinate system's axes as a grid with the renderer.
- Parameters
-
stepSize The size of each row/column in each axis grid. numberOfSteps The number of rows/columns in each axis grid. labels True to draw the name and values of the axis as a bitmap string. x True to draw the x axis. y True to draw the y axis. z True to draw the z axis.
◆ drawGridPlane()
|
virtual |
Draw a coordinate system plane using the y and z axes.
- Parameters
-
stepSize The size of each row/column on the axis grid. numberOfSteps The number of rows/columns on the axis grid. labels True to draw the names and values of the axes.
◆ drawIcoSphere() [1/4]
|
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
-
position The 3D position point to use when drawing the icosphere. radius The radius to use when drawing this icosphere.
◆ drawIcoSphere() [2/4]
|
virtual |
Draw an icosphere with the renderer at the origin using radius.
- Parameters
-
radius The radius to use when drawing the icosphere with this renderer.
◆ drawIcoSphere() [3/4]
|
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
-
x The x coordinate to use when drawing this icosphere. y The y coordinate to use when drawing this icosphere. radius The radius to use when drawing this icosphere.
◆ drawIcoSphere() [4/4]
|
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
-
x The x coordinate to use when drawing this icosphere. y The y coordinate to use when drawing this icosphere. z The z coordinate to use when drawing this icosphere. radius The radius to use when drawing this icosphere.
◆ drawLine()
|
pure virtual |
Draw a line between two 3D points.
- Parameters
-
x1 The x coordinate of the first point. y1 The y coordinate of the first point. z1 The z coordinate of the first point. x2 The x coordinate of the second point. y2 The y coordinate of the second point. z2 The z coordinate of the second point.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ drawPlane() [1/4]
|
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
-
position A 3D point to use as the position to draw the plane with this renderer. width The width to use when drawing the plane with this renderer. height The height to use when drawing the plane with this renderer.
◆ drawPlane() [2/4]
|
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
-
width The width of the plane to use when drawing the plane with this renderer. height The height to use when drawing the plane with this renderer.
◆ drawPlane() [3/4]
|
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
-
x The x coordinate to use when drawing the plane with this renderer. y The y coordinate to use when drawing the plane with this renderer. width The width to use when drawing the plane with this renderer. height The height to use when drawing the plane with this renderer.
◆ drawPlane() [4/4]
|
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
-
x The x coordinate to use when drawing the plane with this renderer. y The y coordinate to use when drawing the plane with this renderer. z The z coordinate to use when drawing the plane with this renderer. width The width to use when drawing the plane with this renderer. height The height to use when drawing the plane with this renderer.
◆ drawRectangle()
|
pure virtual |
Draw a rectangle using a 3D point and a width and height.
- Parameters
-
x The x coordinate of the rectangle. y The y coordinate of the rectangle. z The z coordinate of the rectangle. w The width of the rectangle. h The height of the rectangle.
- See also
- ofRectMode
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ drawRotationAxes()
|
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
-
radius The radius to draw the rotation axes with. stripWidth The width of each axis line. circleRes The circle resolution to use when drawing the axes.
◆ drawSphere() [1/4]
|
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
-
position The 3D position point to use when drawing the sphere. radius The radius to use when drawing this sphere.
◆ drawSphere() [2/4]
|
virtual |
Draw a sphere with the renderer at the defualt origin using radius.
- Parameters
-
radius The radius to use when drawing the sphere with this renderer.
◆ drawSphere() [3/4]
|
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
-
x The x coordinate to use when drawing this sphere. y The y coordinate to use when drawing this sphere. radius The radius to use when drawing this sphere.
◆ drawSphere() [4/4]
|
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
-
x The x coordinate to use when drawing this sphere. y The y coordinate to use when drawing this sphere. z The z coordinate to use when drawing this sphere. radius The radius to use when drawing this sphere.
◆ drawString() [1/2]
|
pure virtual |
Draw text with this renderer using an ofTrueType font.
- Parameters
-
font The font to use when drawing text
.text The text to draw with the renderer. x The x position for the bottom of text
.y The y position for the left alignment of text
.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ drawString() [2/2]
|
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
-
text The text to draw with the renderer. x The x position for the bottom of text
.y The y position for the left alignment of text
.z The z position of the text.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ drawTriangle()
|
pure virtual |
Draw a triangle using three 3D points.
- Parameters
-
x1 The x coordinate of the first point. y1 The y coordinate of the first point. z1 The z coordinate of the first point. x2 The x coordinate of the second point. y2 The y coordinate of the second point. z2 The z coordinate of the second point. x3 The x coordinate of the third point. y3 The y coordinate of the third point. z3 The z coordinate of the third point.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ enableAntiAliasing()
|
pure virtual |
Enable this renderer to use anti-aliasing if it is supported.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ finishRender()
|
pure virtual |
Stop using this renderer as the rendering surface.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ get3dGraphics() [1/2]
|
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]
|
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()
|
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()
|
pure virtual |
Get this renderer's current background color.
- Returns
- This renderer's current background color.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ getBoxResolution()
|
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()
|
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()
|
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()
|
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()
|
pure virtual |
Get this renderer's current normal matrix.
- Returns
- This renderer's current normal matrix.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ getCurrentOrientationMatrix()
|
pure virtual |
Get this renderer's current orientation matrix.
- Returns
- This renderer's current orientation matrix.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ getCurrentViewMatrix()
|
pure virtual |
Get this renderer's current view matrix.
- Returns
- This renderer's current view matrix.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ getCurrentViewport()
|
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()
|
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()
|
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()
|
virtual |
Get this renderer's current icosphere resolution.
- Returns
- This renderer's current icosphere resolution.
◆ getNativeViewport()
|
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()
|
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()
|
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()
|
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()
|
virtual |
Get this renderer's current sphere resolution.
- Returns
- This renderer's current sphere resolution.
◆ getStyle()
|
pure virtual |
Get this renderer's current style object.
- Returns
- This renderer's current style object.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ 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()
|
pure virtual |
Get the renderer's current viewport width.
- Returns
- The renderer's current viewport width.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ getViewportWidth()
|
pure virtual |
Get the renderer's current viewport width.
- Returns
- The renderer's current viewport width.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ isVFlipped()
|
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()
|
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]
|
pure virtual |
Load m as this renderer's current matrix.
m
can be passed to loadMatrix() in this way from raw data
- Parameters
-
m Float pointer to an 4x4 matrix.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ loadMatrix() [2/2]
|
pure virtual |
Load a matrix as this renderer's current matrix.
- Parameters
-
m The matrix to load into this renderer.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ loadViewMatrix()
|
pure virtual |
Load m
into this renderer's matrix stack as a view matrix.
- Parameters
-
m The view matrix to load into this renderer's matrix stack.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ matrixMode()
|
pure virtual |
Sets this renderer's current matrix mode.
The possible matrix modes include: OF_MATRIX_MODELVIEW OF_MATRIX_PROJECTION OF_MATRIX_TEXTURE
- Parameters
-
mode The matrix mode this renderer's matrix should use.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ multMatrix() [1/2]
|
pure virtual |
Multiply this renderer's current matrix by m
.
m
can be passed to loadMatrix() in this way with raw data
- Parameters
-
m Float pointer to an mat4 to multiply this renderer's current matrix by.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ multMatrix() [2/2]
|
pure virtual |
Multiply this renderer's current matrix by m
.
- Parameters
-
m The matrix to multiply this renderer's current matrix by.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ multViewMatrix()
|
pure virtual |
Multiply this renderer's view matrix by m
.
- Parameters
-
m The matrix to multiply this renderer's view matrix by.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ 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()
|
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()
|
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()
|
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()
|
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()
|
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]
|
virtual |
Rotate this renderer's current matrix by degrees
about the z axis.
This method is an alias of rotateZ().
- Parameters
-
degrees Degrees to rotate about the z axis.
- See also
- rotateZ()
Reimplemented in ofRendererCollection, and ofGLRenderer.
◆ rotateDeg() [2/2]
|
virtual |
Rotate this renderer's current matrix by degrees
about a euler.
- Parameters
-
degrees Degrees to rotate about vecX, vecY, and vecZ. vecX The x axis to rotate about. vecY The y axis to rotate about. vecZ The z axis to rotate about.
Reimplemented in ofRendererCollection, and ofGLRenderer.
◆ rotateRad() [1/2]
|
pure virtual |
Rotate this renderer's current matrix by degrees
about the z axis.
This method is an alias of rotateZ().
- Parameters
-
degrees Degrees to rotate about the z axis.
- See also
- rotateZ()
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ rotateRad() [2/2]
|
pure virtual |
Rotate this renderer's current matrix by degrees
about a euler.
- Parameters
-
degrees Degrees to rotate about vecX, vecY, and vecZ. vecX The x axis to rotate about. vecY The y axis to rotate about. vecZ The z axis to rotate about.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ rotateXDeg()
|
virtual |
Rotate this renderer's current matrix by degrees
about the x axis.
- Parameters
-
degrees Degrees to rotate about the x axis.
Reimplemented in ofRendererCollection, and ofGLRenderer.
◆ rotateXRad()
|
pure virtual |
Rotate this renderer's current matrix by degrees
about the x axis.
- Parameters
-
degrees Degrees to rotate about the x axis.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ rotateYDeg()
|
virtual |
Rotate this renderer's current matrix by degrees
about the y axis.
- Parameters
-
degrees Degrees to rotate about the y axis.
Reimplemented in ofRendererCollection, and ofGLRenderer.
◆ rotateYRad()
|
pure virtual |
Rotate this renderer's current matrix by degrees
about the y axis.
- Parameters
-
degrees Degrees to rotate about the y axis.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ rotateZDeg()
|
virtual |
Rotate this renderer's current matrix by degrees
about the z axis.
- Parameters
-
degrees Degrees to rotate about the z axis.
Reimplemented in ofRendererCollection, and ofGLRenderer.
◆ rotateZRad()
|
pure virtual |
Rotate this renderer's current matrix by degrees
about the z axis.
- Parameters
-
degrees Degrees to rotate about the z axis.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ scale()
|
pure virtual |
Scale this renderer's current matrix by xAmnt, yAmnt, and zAmnt.
- Parameters
-
xAmnt The amount to scale this renderer's current matrix's x axis by. yAmnt The amount to scale this renderer's current matrix's y axis by. zAmnt The amount to scale this renderer's current matrix's z axis by. Defaults to 1.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setBackgroundAuto()
|
pure virtual |
Enable/disable automatic redrawing of the background each frame.
- Parameters
-
bManual False to disable automatic background redrawing.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setBackgroundColor()
|
pure virtual |
Set this renderer's background color.
- Parameters
-
c The color to request this renderer to use.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setBitmapTextMode()
|
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
-
mode The bitmap mode to request this renderer to use.
- See also
- ofDrawBitmapMode
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setBlendMode()
|
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
-
degrees Degrees 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
-
blendMode The blend mode to request this renderer to use.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setBoxResolution() [1/2]
|
virtual |
Set the resolution this renderer uses when drawing boxes.
- Parameters
-
res The resolution to use for box widths, heights, and depths.
◆ setBoxResolution() [2/2]
|
virtual |
Set the resolution this renderer uses when drawing boxes.
- Parameters
-
resWidth The width resolution this renderer uses when drawing boxes. resHeight The height resolution this renderer uses when drawing boxes. resDepth The depth resolution this renderer uses when drawing boxes.
◆ setCircleResolution()
|
pure virtual |
Set the resolution to use when drawing ellipses with this renderer.
- Parameters
-
res The number of points to use when drawing circles and ellipses with this renderer.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofRendererCollection, and ofCairoRenderer.
◆ setColor() [1/5]
|
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
-
color The color to use when drawing.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setColor() [2/5]
|
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
-
color The color to use when drawing. _a The alpha value between 0 and 255 to use when drawing.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setColor() [3/5]
|
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
-
gray The grayscale value to use when drawing.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setColor() [4/5]
|
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
-
r The red value between 0 and 255 to use when drawing. g The green value between 0 and 255 to use when drawing. b The blue value between 0 and 255 to use when drawing.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setColor() [5/5]
|
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
-
r The red value between 0 and 255 to use when drawing. g The green value between 0 and 255 to use when drawing. b The blue value between 0 and 255 to use when drawing. a The alpha value between 0 and 255 to use when drawing.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setConeResolution()
|
virtual |
Set the resolution of a polygonized cone.
Allows you to set the polygonization resolution of any cones you subsequently draw with ofDrawCone().
- Parameters
-
radiusSegments The number of facets (subdivisions) around the cone's circular footprint. heightSegments The number of subdivisions from the cone's top to bottom. capSegments The number of annular (ring-shaped) subdivisions of the cone's endcap.
◆ setCoordHandedness()
|
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
-
handedness The 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()
|
pure virtual |
Set the resolution used when drawing curves with this renderer.
- Parameters
-
resolution The resolution to request this renderer to use when drawing curves.
Implemented in ofRendererCollection, ofGLProgrammableRenderer, ofGLRenderer, and ofCairoRenderer.
◆ setCylinderResolution()
|
virtual |
Set this renderer's cylinder resolution.
- Parameters
-
radiusSegments The number of facets (subdivisions) around the icosphere's circular footprint. A larger number yields a higher resolution. heightSegments The number of subdivisions from the cylinder's top to bottom. capSegments The number of annular (ring-shaped) subdivisions of the cylinder's endcap. Defaults to 2.
◆ setDepthTest()
|
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
-
depthTest True to enable depth testing.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setFillMode()
|
pure virtual |
set this renderer's fill flag.
Possible fill flags include OF_OUTLINE and OF_FILLED.
- Parameters
-
fill The fill flag to request this renderer to use.
- See also
- ofFillFlag
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setHexColor()
|
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
-
hexColor The hexidecimal representation of the color to use when drawing.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setIcoSphereResolution()
|
virtual |
Set the point resolution to use when drawing an icosphere with this renderer.
- Parameters
-
res The desired icosphere resolution to use with this renderer.
◆ setLineSmoothing()
|
pure virtual |
Enable/disable line smoothing for this renderer if it's supported.
- Parameters
-
smooth True to enable line smoothing for this renderer if it's supported.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setLineWidth()
|
pure virtual |
Set the line width this renderer should use when drawing lines.
- Parameters
-
lineWidth The line width to request this renderer to use.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setOrientation()
|
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
-
orientation The orientation to use with this renderer. vFlip True if the orientation should be vertically flipped.
- See also
- ofOrientation
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setPlaneResolution()
|
virtual |
Set this renderer's plane resolution using column
and rows
.
- Parameters
-
columns The number of columns to use when drawing planes with this renderer. rows The number of rows to use when drawing planes with this renderer.
◆ setPolyMode()
|
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
-
mode The poly winding mode to request this renderer to use.
- See also
- ofPolyWindingMode
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setRectMode()
|
pure virtual |
Set this renderer's rect mode.
Possible rect modes include OF_RECTMODE_CORNER and OF_RECTMODE_CENTER.
- Parameters
-
mode The rect mode to request this renderer to use.
- See also
- ofRectMode
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setSphereResolution()
|
virtual |
Set the point resolution to use when drawing a sphere with this renderer.
UV Sphere
- Parameters
-
res The desired sphere resolution to use with this renderer.
◆ setStyle()
|
pure virtual |
Set this renderer's current style object.
- Parameters
-
style The style object to set this renderer to use.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setupGraphicDefaults()
|
pure virtual |
setup the default graphics settings for this renderer.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setupScreen()
|
pure virtual |
setup the default screen settings for this renderer.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ setupScreenOrtho()
|
pure virtual |
Setup the renderer to use an orthographic matrix.
- Parameters
-
width The width of the desired orthographic matrix. Defaults to -1 setting its width according to the rendering surface's width. height The height of the desired orthographic matrix. Defaults to -1 setting its height according to the rendering surface's height. nearDist The near clipping distance to use with the orthographic matrix. Setting this value to 0 uses the defualt near distance. Defaults to 0. farDist The 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()
|
pure virtual |
Setup the renderer to use a perspective matrix.
- Parameters
-
width The width of the desired perspective matrix. Defaults to -1 setting its width according to the rendering surface's width. height The height of the desired perspective matrix. Defaults to Defaults to -1 setting its width according to the rendering surface's width. fov The field of view to use with the perspective matrix. Defaults to 60. nearDist The near clipping distance to use with the perspective matrix. Setting this value to 0 uses the default near distance. Defaults to 0. farDist The 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()
|
pure virtual |
Starts using this renderer as the rendering surface.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ translate() [1/2]
|
pure virtual |
Translate this renderer's current matrix by a point.
- Parameters
-
p The 3D point to translate this renderer's current matrix by.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ translate() [2/2]
|
pure virtual |
Translate this renderer's current matrix by x, y, and z.
- Parameters
-
x The x coordinate to translate this renderer's current matrix by. y The y coordinate to translate this renderer's current matrix by. z The z coordinate to translate this renderer's current matrix by. Defaults to 0.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, and ofRendererCollection.
◆ unbind()
|
pure virtual |
Unbind the camera from this renderer.
- Parameters
-
camera The camera to unbind from this renderer.
Implemented in ofGLProgrammableRenderer, ofGLRenderer, ofCairoRenderer, ofRendererCollection, and ofBaseGLRenderer.
◆ viewport() [1/2]
|
pure virtual |
Set this renderer's viewport manually using x, y, width, and height.
- Parameters
-
x The x coordinate of the viewport. Defaults to 0. y The y coordinate of the viewport. Defaults to 0. w The width of the viewport. Defaults to -1 setting its width according to the rendering surface's width. h The 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]
|
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:
- /Users/icq4ever/Desktop/oF0120/libs/openFrameworks/graphics/ofGraphicsBaseTypes.h
- /Users/icq4ever/Desktop/oF0120/libs/openFrameworks/graphics/ofGraphicsBaseTypes.cpp
- /Users/icq4ever/Desktop/oF0120/libs/openFrameworks/types/ofBaseTypes.cpp