Register / Login

documentation

This page the start documentation for the main OF api. There are also additional libraries that you can find on the addons page. This api is a work in progress and any corrections, additions or comments are very welcome!

This document refers to version 0.06

Show advanced?
yes / no

   application
   class ofBaseApp
    setup()
    update()
    draw()
    exit()
    windowResized(...)
    keyPressed(...)
    keyReleased(...)
    mouseMoved(...)
    mouseDragged(...)
    mousePressed(...)
    mouseReleased()
    mouseReleased(...)
    audioReceived(...)
    audioRequested(...)
    mouseX
    mouseY
   ofGetFrameRate()
   ofGetFrameNum()
   ofSetFrameRate()
   ofSetupOpenGL(...)
   ofHideCursor()
   ofShowCursor()
   ofGetWindowPositionX()
   ofGetWindowPositionY()
   ofGetScreenWidth()
   ofGetScreenHeight()
   ofGetWindowMode()
   ofGetWidth()
   ofGetHeight()
   ofSetWindowPosition(...)
   ofSetWindowShape(...)
   ofSetWindowTitle()
   ofSetFullscreen(...)
   ofToggleFullscreen()
   ofSetVerticalSync(...)

   utils
   ofGetElapsedTimef()
   ofGetElapsedTimeMillis()
   ofGetFrameNum()
   ofGetSeconds()
   ofGetMinutes()
   ofGetHours()
   ofLaunchBrowser(...)
   ofToString(...)
   ofGetVersionInfo()
   ofToInt(...)
   ofToFloat(...)
   ofSaveScreen(...)
   ofSaveFrame()
   ofSplitString(...)
   ofGetYear()
   ofGetMonth()
   ofGetDay()
   ofGetWeekday()

   types
   class ofColor
    r ,     g ,     b ,     a
   class ofPoint
    set(...)
    operator-()
    operator==(...)
    operator!=(...)
    operator=(...)
    operator=(...)
    operator+(...)
    operator+(...)
    operator+=(...)
    operator+=(...)
    operator-(...)
    operator-(...)
    operator-=(...)
    operator-=(...)
    operator*(...)
    operator*(...)
    operator*=(...)
    operator*=(...)
    operator/(...)
    operator/(...)
    operator/=(...)
    operator/=(...)
    x ,     y ,     z ,     v
   class ofRectangle
    x ,     y
    width
    height
   math
   ofSeedRandom()
   ofSeedRandom(...)
   ofRandom(...)
   ofRandomf()
   ofRandomuf()
   ofNextPow2(...)
   ofNormalize(...)
   ofMap(...)
   ofClamp(...)
   ofLerp(...)
   ofDist(...)
   ofDistSquared(...)
   ofSign(...)
   ofInRange(...)
   ofRadToDeg(...)
   ofDegToRad(...)
   ofRandomWidth()
   ofRandomHeight()

   constants
   PI
   TWO_PI
   M_TWO_PI
   FOUR_PI
   HALF_PI
   DEG_TO_RAD
   RAD_TO_DEG
   MIN
   MAX
   CLAMP
   ABS
   OF_KEY_RETURN
   OF_KEY_ESC
   OF_KEY_F1
   OF_KEY_F2
   OF_KEY_F3
   OF_KEY_F4
   OF_KEY_F5
   OF_KEY_F6
   OF_KEY_F7
   OF_KEY_F8
   OF_KEY_F9
   OF_KEY_F10
   OF_KEY_F11
   OF_KEY_F12
   OF_KEY_LEFT
   OF_KEY_UP
   OF_KEY_RIGHT
   OF_KEY_DOWN
   OF_KEY_PAGE_UP
   OF_KEY_PAGE_DOWN
   OF_KEY_HOME
   OF_KEY_END
   OF_KEY_INSERT
   OF_KEY_BACKSPACE
   OF_KEY_DEL

   graphics
   ofBackground(...)
   ofBgColorPtr()
   ofSetBackgroundAuto(...)
   ofbClearBg()
   ofSetCircleResolution(...)
   ofSetRectMode(...)
   ofGetRectMode()
   ofRect(...)
   ofTriangle(...)
   ofCircle(...)
   ofEllipse(...)
   ofLine(...)
   ofCurve(...)
   ofBezier(...)
   ofSetPolyMode(...)
   ofBeginShape()
   ofVertex(...)
   ofCurveVertex(...)
   ofBezierVertex(...)
   ofNextContour(...)
   ofEndShape(...)
   ofNoFill()
   ofFill()
   ofSetColor(...)
   ofSetColor(...)
   ofSetColor(...)
   ofEnableAlphaBlending()
   ofDisableAlphaBlending()
   ofEnableSmoothing()
   ofDisableSmoothing()
   ofDrawBitmapString(...)
   ofRotate(...)
   ofRotateX(...)
   ofRotateY(...)
   ofRotateZ(...)
   ofPushStyle()
   ofPopStyle()
   ofSetStyle(...)
   ofGetStyle()
   ofSetLineWidth(...)
   ofPushMatrix()
   ofPopMatrix()
   ofTranslate(...)
   ofScale(...)

   class ofImage
    allocate(...)
    clear()
    operator=(...)
    clone(...)
    setUseTexture(...)
    getTextureReference()
    loadImage(...)
    saveImage(...)
    getPixels()
    setFromPixels(...)
    setImageType(...)
    resize(...)
    grabScreen(...)
    update()
    draw(...)
    draw(...)
    getWidth()
    getHeight()
    width
    height
    type
    bpp
   class ofTexture
    operator=(...)
    allocate(...)
    allocate(...)
    clear()
    loadData(...)
    loadScreenData(...)
    draw(...)
    draw(...)
    bAllocated()
    getHeight()
    getWidth()
   class ofTrueTypeFont
    loadFont(...)
    loadFont(...)
    getLineHeight()
    setLineHeight(...)
    stringWidth(...)
    stringHeight(...)
    getStringBoundingBox(...)
    drawString(...)
    drawStringAsShapes(...)
    bLoadedOk
    bAntiAlised
    bFullCharacterSet
    nCharacters
   video
   class ofVideoGrabber
    listDevices()
    isFrameNew()
    grabFrame()
    close()
    initGrabber(...)
    videoSettings()
    getPixels()
    getTextureReference()
    setDeviceID(...)
    setUseTexture(...)
    draw(...)
    draw(...)
    update()
    getHeight()
    getWidth()
    height
    width
   class ofVideoPlayer
    loadMovie(...)
    closeMovie()
    close()
    update()
    idleMovie()
    play()
    stop()
    isFrameNew()
    getPixels()
    getPosition()
    getSpeed()
    getDuration()
    getIsMovieDone()
    setPosition(...)
    setVolume(...)
    setLoopState(...)
    setSpeed(...)
    setFrame(...)
    setUseTexture(...)
    getTextureReference()
    draw(...)
    draw(...)
    setPaused(...)
    getCurrentFrame()
    getTotalNumFrames()
    firstFrame()
    nextFrame()
    previousFrame()
    getHeight()
    getWidth()
    width
    height
    speed
    bLoaded
    nFrames
    pixels
    bHavePixelsChanged
    tex
    bUseTexture
    allocated
   sound player
   ofSoundSetVolume(...)
   ofSoundStopAll()
   ofSoundGetSpectrum(...)

   class ofSoundPlayer
    loadSound(...)
    unloadSound()
    play()
    stop()
    setVolume(...)
    setPan(...)
    setSpeed(...)
    setPaused(...)
    setLoop(...)
    setMultiPlay(...)
    setPosition(...)
    getPosition()
    getIsPlaying()
    getSpeed()
    getPan()
    isStreaming
    bMultiPlay
    bLoop
    bLoadedOk
    bPaused
    pan
    volume
    speed
    length
   sound stream
   ofSoundStreamSetup(...)
   ofSoundStreamSetup(...)
   ofSoundStreamStop()
   ofSoundStreamStart()
   ofSoundStreamEnd()
   ofSoundStreamEnumerateDevices()

   serial
   class ofSerial
    enumerateDevices()
    close()
    setup()
    setup(...)
    setup(...)
    readBytes(...)
    writeBytes(...)
    writeByte(...)
    readByte()
    flush(...)
    available()
   arduino
   class ofArduino
    connect(...)
    connect(...)
    disconnect()
    isArduinoReady()
    update()
    setUseDelay(...)
    isInitialized()
    sendDigitalPinMode(...)
    sendAnalogPinReporting(...)
    sendDigital(...)
    sendPwm(...)
    sendString(...)
    sendReset()
    sendByte(...)
    getPwm(...)
    getDigital(...)
    getAnalog(...)
    getString()
    getDigitalPinMode(...)
    getAnalogPinReporting(...)