ofAppEGLWindowfile

Enums

ofAppEGLWindowType enum

ofAppEGLWindowType

Enumerator
OF_APP_WINDOW_AUTO
OF_APP_WINDOW_NATIVE
OF_APP_WINDOW_X11

Typedefs

ofEGLAttributeList typedef

map< EGLint, EGLint > ofEGLAttributeList

ofEGLAttributeListIterator typedef

map< EGLint, EGLint >::iterator ofEGLAttributeListIterator

ofAppEGLWindow::Settingsstruct

Attributes

eglWindowPreference variable

ofAppEGLWindowType eglWindowPreference

eglWindowOpacity variable

EGLint eglWindowOpacity

frameBufferAttributes variable

ofEGLAttributeList frameBufferAttributes

windowSurfaceAttributes variable

ofEGLAttributeList windowSurfaceAttributes

initialClearColor variable

ofColor initialClearColor

screenNum variable

int screenNum

layer variable

int layer

Functions

Settings ()

Settings()

ofAppEGLWindowclass

Functions

ofAppEGLWindow ()

ofAppEGLWindow()

ofAppEGLWindow(Settings settings)

~ofAppEGLWindow ()

~ofAppEGLWindow()

setThreadTimeout ()

void setThreadTimeout(long timeOut)

setGLESVersion ()

void setGLESVersion(int glesVersion)

setupOpenGL ()

void setupOpenGL(int w, int h, ofWindowMode screenMode)

initializeWindow ()

void initializeWindow()

runAppViaInfiniteLoop ()

void runAppViaInfiniteLoop(ofBaseApp *appPtr)

windowShouldClose ()

void windowShouldClose()

hideCursor ()

void hideCursor()

Reimplemented from ofAppBaseWindow.

showCursor ()

void showCursor()

Reimplemented from ofAppBaseWindow.

setWindowPosition ()

void setWindowPosition(int x, int y)

Reimplemented from ofAppBaseWindow.

setWindowShape ()

void setWindowShape(int w, int h)

Reimplemented from ofAppBaseWindow.

getWindowPosition ()

ofPoint getWindowPosition()

Reimplemented from ofAppBaseWindow.

getWindowSize ()

ofPoint getWindowSize()

Reimplemented from ofAppBaseWindow.

getScreenSize ()

ofPoint getScreenSize()

Reimplemented from ofAppBaseWindow.

setOrientation ()

void setOrientation(ofOrientation orientation)

Reimplemented from ofAppBaseWindow.

getOrientation ()

ofOrientation getOrientation()

Reimplemented from ofAppBaseWindow.

doesHWOrientation ()

bool doesHWOrientation()

Reimplemented from ofAppBaseWindow.

getWidth ()

int getWidth()

Reimplemented from ofAppBaseWindow.

getHeight ()

int getHeight()

Reimplemented from ofAppBaseWindow.

setWindowTitle ()

void setWindowTitle(string title)

Reimplemented from ofAppBaseWindow.

getWindowMode ()

ofWindowMode getWindowMode()

Reimplemented from ofAppBaseWindow.

setFullscreen ()

void setFullscreen(bool fullscreen)

Reimplemented from ofAppBaseWindow.

toggleFullscreen ()

void toggleFullscreen()

Reimplemented from ofAppBaseWindow.

enableSetupScreen ()

void enableSetupScreen()

Reimplemented from ofAppBaseWindow.

disableSetupScreen ()

void disableSetupScreen()

Reimplemented from ofAppBaseWindow.

setVerticalSync ()

void setVerticalSync(bool enabled)

Reimplemented from ofAppBaseWindow.

getEglDisplay ()

EGLDisplay getEglDisplay() const

getEglSurface ()

EGLSurface getEglSurface() const

getEglContext ()

EGLContext getEglContext() const

getX11Display ()

Display * getX11Display()

getX11Window ()

Window getX11Window()

getEglConfig ()

EGLConfig getEglConfig() const

getEglVersionMajor ()

EGLint getEglVersionMajor() const

getEglVersionMinor ()

EGLint getEglVersionMinor() const

setup ()

void setup(const ofGLESWindowSettings &settings)=0

void setup(const ofWindowSettings &settings)

Implements ofAppBaseWindow.

update ()

void update()=0

Implemented in ofAppGLFWWindow, ofAppGlutWindow, and ofAppNoWindow.

draw ()

void draw()=0

Implemented in ofAppGLFWWindow, ofAppGlutWindow, and ofAppNoWindow.

getWindowShouldClose ()

bool getWindowShouldClose()

Reimplemented in ofAppGLFWWindow.

setWindowShouldClose ()

void setWindowShouldClose()

Reimplemented in ofAppGLFWWindow.

close ()

void close()

Reimplemented in ofAppGLFWWindow, and ofAppGlutWindow.

events ()

ofCoreEvents events()=0

Implemented in ofAppGLFWWindow, ofAppGlutWindow, and ofAppNoWindow.

renderer ()

ofBaseRenderer renderer()=0

Implemented in ofAppGLFWWindow, and ofAppGlutWindow.

setClipboardString ()

void setClipboardString(const string &text)

Reimplemented in ofAppGLFWWindow.

getClipboardString ()

string getClipboardString()

Reimplemented in ofAppGLFWWindow.

getWindowContext ()

void * getWindowContext()

Reimplemented in ofAppGLFWWindow.

isThreadRunning ()

bool isThreadRunning() const

Check the running status of the thread.

Returns: true iff the thread is currently running.

getThreadId ()

int getThreadId() const

Get the unique thread id.

Note: This is NOT the the same as the operating thread id!

getThreadName ()

std::string getThreadName() const

Get the unique thread name, in the form of "Thread id#".

Returns: the Thread ID string.

startThread () Use startThread(bool blocking = true) instead.

void startThread(bool mutexesBlock, bool verbose)

Start the thread with options.

Parameters

mutexesBlock	Set blocking to true if you want the mutex to block when lock() is called.
verbose	use verbose logging methods.

getCurrentThread () use ofThread::getCurrentPocoThread() == &yourThread.getPocoThread() to compare threads.

static ofThread getCurrentThread()

startThread ()

void startThread(bool mutexBlocks=true)

Start the thread with options.

Parameters

mutexBlocks Set blocking to true if you want the mutex to block when lock() is called.

Note: Subclasses can directly access the mutex and employ thier own locking strategy.

lock ()

bool lock()

Try to lock the mutex.

If the thread was started startThread(true), then this call will wait until the mutex is available and return true. If the thread was started startThread(false), this call will return true iff the mutex is was successfully acquired.

Returns: true iff the lock was successfully acquired.

unlock ()

void unlock()

Unlock the mutex.

This will only unlocks the mutex if it was previously by the same calling thread.

stopThread ()

void stopThread()

Stop the thread.

This does immediately stop the thread from processing, but will only set a flag that must be checked from within your threadedFunction() by calling isThreadRunning(). If the user wants to both stop the thread AND wait for the thread to finish processing, the user should call waitForThread(true, ...).

waitForThread ()

void waitForThread(bool callStopThread=true, long milliseconds=INFINITE_JOIN_TIMEOUT)

Wait for the thread to exit (aka "joining" the thread).

This method waits for a thread will "block" and wait for the thread (aka "join" the thread) before it returns. This allows the user to be sure that the thread is properly cleaned up. An example of when this might be particularly important is if the threadedFunction() is opening a set of network sockets, or downloading data from the web. Destroying an ofThread subclass without releasing those sockets (or other resources), may result in segmentation faults, error signals or other undefined behaviors.

Parameters

callStopThread Set stop to true if you want to signal the thread to exit before waiting. This is the equivalent to calling stopThread(). If you your threadedFunction uses a while-loop that depends on isThreadRunning() and you do not call stopThread() or set stop == true, waitForThread will hang indefinitely. Set stop == false ONLY if you have already called stopThread() and you simply need to be sure your thread has finished its tasks.

milliseconds If millseconds is set to INFINITE_JOIN_TIMEOUT, the waitForThread will wait indefinitely for the thread to complete. If milliseconds is set to a lower number (e.g. 10000 for 10 seconds), waitForThread will wait for 10000 milliseconds and if the thread has not yet stopped it will return and log an error message. Users are encouraged to use the default INFINITE_JOIN_TIMEOUT. If the user is unhappy with the amount of time it takes to join a thread, the user is encouraged to seek more expedient ways of signalling their desire for a thread to complete via other signalling methods such as Poco::Event, Poco::Condition, or Poco::Semaphore.

See Also: http://pocoproject.org/slides/090-NotificationsEvents.pdf; http://pocoproject.org/docs/Poco.Condition.html; http://pocoproject.org/docs/Poco.Event.html; http://pocoproject.org/docs/Poco.Semaphore.html

sleep ()

void sleep(long milliseconds)

Tell the thread to sleep for a certain amount of milliseconds.

This is useful inside the threadedFunction() when a thread is waiting for input to process:

void MyThreadedClass::threadedFunction()
{
    // start
    while(isThreadRunning())
    {
        // bReadyToProcess can be set from outside the threadedFuntion.
        // perhaps by another thread that downloads data, or loads
        // some media, etc.

        if(bReadyToProcess == true)
        {
            // do some time intensive processing
            bReadyToProcess = false;
        }
        else
        {
            // sleep the thread to give up some cpu
            sleep(20);
        }
    }
    // done
}

If the user does not give the thread a chance to sleep, the thread may take 100% of the CPU core while it's looping as it waits for something to do. This may lead to poor application performance.

Parameters

milliseconds The number of milliseconds to sleep.

yield ()

void yield()

Tell the thread to give up its CPU time other threads.

This method is similar to sleep() and can often be used in the same way. The main difference is that 1 millisecond (the minimum sleep time available with sleep()) is a very long time on modern processors and yield() simply gives up processing time to the next thread, instead of waiting for number of milliseconds. In some cases, this behavior will be preferred.

isCurrentThread ()

bool isCurrentThread() const

Query whether the current thread is active.

In multithreaded situations, it can be useful to know which thread is currently running some code in order to make sure only certain threads can do certain things. For example, OpenGL can only run in the main execution thread. Thus, situations where a thread is responsible for interacting with graphics resources may need to prevent graphics updates unless the main thread is accessing or updating resources shared with this ofThread (or its subclass).

if(myThread.isCurrentThread())
{
    // do some myThread things,
    // but keep your hands off my resources!
}
else if(ofThread::isMainThread())
{
    // pheew! ok, update those graphics resources
}

By way of another example, a subclass of ofThread may have an update() method that is called from ofBaseApp during the execution of the main application thread. In these cases, the ofThread subclass might want to ask itself whether it can, for instance, call update() on an ofImage, in order to send copy some ofPixels to an ofTexture on the graphics card.

Returns: True iff this ofThread the currently active thread.

getPocoThread ()

Poco::Thread & getPocoThread()

Get a reference to the underlying Poco thread.

Poco::Thread provides a clean cross-platform wrapper for threads. On occasion, it may be useful to interact with the underlying Poco::Thread directly.

Returns: A reference to the backing Poco thread.

const Poco::Thread & getPocoThread() const

Get a const reference to the underlying Poco thread.

Poco::Thread provides a clean cross-platform wrapper for threads. On occasion, it may be useful to interact with the underlying Poco::Thread directly.

Returns: A reference to the backing Poco thread.

Types

Anonymous enum enum

Anonymous enum

Enumerator

Enumerator
INFINITE_JOIN_TIMEOUT	A sentinal value for an infinite join timeout. Primarily used with the waitForThread() method.

INFINITE_JOIN_TIMEOUT

A sentinal value for an infinite join timeout.

Primarily used with the waitForThread() method.

Static Functions

isMainThread ()

bool isMainThread()

A query to see if the current thread is the main thread.

Some functions (e.g. OpenGL calls) can only be executed the main thread. This static function will tell the user what thread is currently active at the moment the method is called.

if (ofThread::isMainThread())
{
    ofLogNotice() << "This is the main thread!";
}
else
{
    ofLogNotice() << "This is NOT the main thread.";
}

Returns: true iff the current thread is the main thread.

getCurrentPocoThread ()

Poco::Thread * getCurrentPocoThread()

Get the current Poco thread.

In most cases, it is more appropriate to query the current thread by calling isCurrentThread() on an active thread or by calling ofThread::isMainThread(). See the method documentation for more information on those methods.

Returns: A pointer to the current active thread OR 0 iff the main application thread is active.