Beatmup::GL::RecycleBin Class Reference

Stores references to GPU resources that will not be used anymore and needed to be recycled in a thread having access to the GPU. More...

#include <recycle_bin.h>

Inheritance diagram for Beatmup::GL::RecycleBin:

Classes
class	Item
	A wrapper for a GPU resource. More...

Public Member Functions
	RecycleBin (Context &ctx)
	~RecycleBin ()
void	put (Item *item)
	Puts an item into the recycle bin. More...
void	put (std::initializer_list< Item * > items)
	Puts items into the recycle bin. More...
void	emptyBin ()
	Empty the bin destroying all the items in a GPU-aware thread. More...
Public Member Functions inherited from Beatmup::LockableObject
void	lock ()
void	unlock ()
Public Member Functions inherited from Beatmup::Object
virtual	~Object ()

Private Attributes
std::vector< Item * >	items
Context &	ctx
AbstractTask *	recycler

Detailed Description

Stores references to GPU resources that will not be used anymore and needed to be recycled in a thread having access to the GPU.

GPU resources such as texture handles generally cannot be destroyed in a user thread due to OpenGL API restrictions. They are kept in a RecycleBin until the application empties it, which launches a task running in the thread that can access the GPU.

Definition at line 34 of file recycle_bin.h.

Constructor & Destructor Documentation

RecycleBin()

RecycleBin::RecycleBin

(

Context &

ctx

)

Definition at line 63 of file recycle_bin.cpp.

                                   : ctx(ctx) {
    recycler = new Internal::Recycler(items);
}

~RecycleBin()

RecycleBin::~RecycleBin

(

)

Definition at line 68 of file recycle_bin.cpp.

                        {
    delete recycler;
}

Member Function Documentation

put() [1/2]

void RecycleBin::put

(

RecycleBin::Item *

item

)

Puts an item into the recycle bin.

Definition at line 73 of file recycle_bin.cpp.

                                         {
    if (item) {
        lock();
        items.push_back(item);
        unlock();
    }
}

put() [2/2]

void RecycleBin::put

(

std::initializer_list< Item * >

items

)

Puts items into the recycle bin.

Definition at line 82 of file recycle_bin.cpp.

                                                     {
    lock();
    for (auto item : items)
        if (item)
            this->items.push_back(item);
    unlock();
}

emptyBin()

void RecycleBin::emptyBin

(

)

Empty the bin destroying all the items in a GPU-aware thread.

Definition at line 91 of file recycle_bin.cpp.

                          {
    lock();
    if (items.size() > 0)
        ctx.performTask(*recycler);
    unlock();
}

Member Data Documentation

items

std::vector<Item*> Beatmup::GL::RecycleBin::items

private

Definition at line 48 of file recycle_bin.h.

ctx

Context& Beatmup::GL::RecycleBin::ctx

private

Definition at line 49 of file recycle_bin.h.

recycler

AbstractTask* Beatmup::GL::RecycleBin::recycler

private

Definition at line 50 of file recycle_bin.h.

---

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

• core/gpu/recycle_bin.h
• core/gpu/recycle_bin.cpp