Back to index

nux  3.0.0
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends
nux::IOpenGLResource Class Reference

#include <IOpenGLResource.h>

Inheritance diagram for nux::IOpenGLResource:
Inheritance graph
[legend]
Collaboration diagram for nux::IOpenGLResource:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 IOpenGLResource (OpenGLResourceType ResourceType, NUX_FILE_LINE_PROTO)
virtual ~IOpenGLResource ()
virtual int RefCount () const
OpenGLResourceType GetResourceType () const
int GetOpenGLID () const
 NUX_DECLARE_OBJECT_TYPE (BaseObject, Trackable)
bool Reference ()
 Increase reference count.
bool UnReference ()
 Decrease reference count.
virtual bool SinkReference ()
 Mark the object as owned.
virtual bool Dispose ()
 Destroy and object that has a floating reference.
int GetReferenceCount () const
 Get the reference count of this object.
std::string GetAllocationLoation () const
 NUX_DECLARE_ROOT_OBJECT_TYPE (Trackable)
bool OwnsTheReference ()
 Test if object reference is owned.
bool IsHeapAllocated ()
 Test if object was allocated dynamically.
bool IsDynamic () const
 Test if object was allocated dynamically.
virtual int GetObjectSize ()
 Return the size of allocated for this object.
bool SetProperty (std::string const &name, const char *value)
 If the property was not able to be set with the value, the method returns false.
template<typename T >
bool SetProperty (std::string const &name, T const &value)
template<typename T >
GetProperty (std::string const &name, T *foo=0)
void AddProperty (std::string const &name, PropertyBase *property)

Static Public Member Functions

static std::new_handler set_new_handler (std::new_handler handler)
static void * operator new (size_t size)
static void * operator new (size_t size, void *ptr)
static void operator delete (void *ptr)

Public Attributes

sigc::signal< void, Object * > object_destroyed
 Signal emitted immediately before the object is destroyed.

Protected Member Functions

void SetOwnedReference (bool b)

Protected Attributes

int _heap_allocated

Private Member Functions

 NUX_DECLARE_OBJECT_TYPE (IOpenGLResource, Object)

Private Attributes

GLuint _OpenGLID
int _RefCount
OpenGLResourceType _ResourceType

Friends

class IOpenGLFrameBufferObject
class IOpenGLSurface
class IOpenGLBaseTexture
class IOpenGLCubeTexture
class IOpenGLVolumeTexture
class IOpenGLAnimatedTexture
class IOpenGLTexture2D
class IOpenGLRectangleTexture
class IOpenGLVolume
class IOpenGLQuery
class GpuDevice
class IOpenGLIndexBuffer
class IOpenGLVertexBuffer
class IOpenGLVertexDeclaration
class IOpenGLShader
class IOpenGLVertexShader
class IOpenGLPixelShader
class IOpenGLGeometryShader
class IOpenGLShaderProgram
class IOpenGLAsmVertexShader
class IOpenGLAsmPixelShader
class IOpenGLAsmShaderProgram
class IOpenGLPixelBufferObject

Detailed Description

Definition at line 73 of file IOpenGLResource.h.


Constructor & Destructor Documentation

Definition at line 78 of file IOpenGLResource.h.

      : Object(true, NUX_FILE_LINE_PARAM)
      , _OpenGLID(0)
      , _RefCount(0)
      , _ResourceType(ResourceType)
    {
    }
virtual nux::IOpenGLResource::~IOpenGLResource ( ) [inline, virtual]

Definition at line 86 of file IOpenGLResource.h.

    {

    }

Member Function Documentation

void nux::Introspectable::AddProperty ( std::string const &  name,
PropertyBase property 
) [inline, inherited]

Definition at line 254 of file Property-inl.h.

{
  // check to see if it exists and if it does barf horribly as we can't
  // have two properties with the same name;
  properties_[name] = property;
}

Here is the caller graph for this function:

bool nux::Object::Dispose ( ) [virtual, inherited]

Destroy and object that has a floating reference.

Returns:
True is the object has been destroyed

Reimplemented from nux::Trackable.

Definition at line 311 of file Object.cpp.

  {
    // The intent of the Dispose call is to destroy objects with a float
    // reference (reference count is equal to 1 and the '_owns_the_reference'
    // flag is set to false). In Nux, only widgets object can have a floating
    // reference.  And widgets are only visible if added to the widget tree.
    // When an object with a floating reference is added to the widget tree,
    // it becomes "owned'. It looses it floating reference status but it still
    // has a reference count number of 1.  In practice, since widgets must be
    // added to the widget tree, there should never be a need to call Dispose
    // (except in a few cases).

    // Dispose() was designed to only destroy objects with floating
    // references, while UnReference() destroys objects that are "owned".
    // That is now relaxed. Dispose() calls UnReference().
    return UnReference();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

std::string nux::Object::GetAllocationLoation ( ) const [inherited]

Definition at line 348 of file Object.cpp.

{
  std::ostringstream sout;
  sout << allocation_file_name_ << ":" << allocation_line_number_;
  return sout.str();
}

Here is the caller graph for this function:

int nux::Trackable::GetObjectSize ( ) [virtual, inherited]

Return the size of allocated for this object.

Returns:
The size allocated for this object.

Definition at line 217 of file Object.cpp.

  {
    return _size_of_this_object;
  }
int nux::IOpenGLResource::GetOpenGLID ( ) const [inline]

Definition at line 101 of file IOpenGLResource.h.

    {
      return _OpenGLID;
    }

Here is the caller graph for this function:

template<typename T >
T nux::Introspectable::GetProperty ( std::string const &  name,
T *  foo = 0 
) [inherited]

Definition at line 285 of file Property-inl.h.

{
  PropertyContainer::iterator i = properties_.find(name);
  if (i == properties_.end())
    return T();

  std::string s = i->second->GetSerializedValue();
  std::pair<T, bool> result = type::PropertyTrait<T>::from_string(s);
  // If this is called with a template type that the property does not
  // support nice conversion to, you'll get no error, but will get
  // a default constructed T.  We could use an exception here.
  return result.first;
}
int nux::Object::GetReferenceCount ( ) const [inherited]

Get the reference count of this object.

Returns:
The reference count of this object.

Definition at line 343 of file Object.cpp.

  {
    return reference_count_->GetValue();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

Definition at line 96 of file IOpenGLResource.h.

    {
      return _ResourceType;
    }

Here is the caller graph for this function:

bool nux::Trackable::IsDynamic ( ) const [inherited]

Test if object was allocated dynamically.

Definition at line 201 of file Object.cpp.

  {
    // Get pointer to beginning of the memory occupied by this.
    const void *ptr = dynamic_cast<const void *> (this);

    // Search for ptr in allocation_list
#if defined(NUX_OS_WINDOWS) && !defined(NUX_VISUAL_STUDIO_2010)
    std::list<void*>::iterator i = std::find(GObjectStats._allocation_list.begin(),
      GObjectStats._allocation_list.end(), ptr);
#else
    auto i = std::find(GObjectStats._allocation_list.begin(),
                       GObjectStats._allocation_list.end(), ptr);
#endif
    return i != GObjectStats._allocation_list.end();
  }

Here is the caller graph for this function:

bool nux::Trackable::IsHeapAllocated ( ) [inherited]

Test if object was allocated dynamically.

Definition at line 191 of file Object.cpp.

  {
    if (_heap_allocated == -1)
    {
      _heap_allocated = (IsDynamic () ? 1 : 0);
    }

    return (_heap_allocated == 1 ? true : false);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

nux::Object::NUX_DECLARE_OBJECT_TYPE ( BaseObject  ,
Trackable   
) [inherited]
void nux::Trackable::operator delete ( void *  ptr) [static, inherited]

Definition at line 178 of file Object.cpp.

  {
    ObjectStats::AllocationList::iterator i = std::find (GObjectStats._allocation_list.begin(), GObjectStats._allocation_list.end(), ptr);

    if (i != GObjectStats._allocation_list.end() )
    {
      GObjectStats._total_allocated_size -= NUX_STATIC_CAST (Trackable *, ptr)->_size_of_this_object;
      --GObjectStats._number_of_objects;
      GObjectStats._allocation_list.erase (i);
      ::operator delete (ptr);
    }
  }
void * nux::Trackable::operator new ( size_t  size) [static, inherited]

Definition at line 140 of file Object.cpp.

  {
    // Set the new_handler for this call
    std::new_handler global_handler  = std::set_new_handler (_new_current_handler);

    // If allocation fails _new_current_handler is called, if specified,
    // otherwise the global new_handler is called.
    void *ptr;

    try
    {
      ptr = ::operator new (size);

      GObjectStats._allocation_list.push_front (ptr);
      NUX_STATIC_CAST (Trackable *, ptr)->_size_of_this_object = size;
      GObjectStats._total_allocated_size += size;
      ++GObjectStats._number_of_objects;
    }
    catch (std::bad_alloc &)
    {
      std::set_new_handler (global_handler);
      throw;
    }

    //  Reset gloabal new_handler
    std::set_new_handler (global_handler);
    return ptr;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void * nux::Trackable::operator new ( size_t  size,
void *  ptr 
) [static, inherited]

Definition at line 171 of file Object.cpp.

  {
    return ::operator new (size, ptr);
  }

Here is the call graph for this function:

bool nux::Trackable::OwnsTheReference ( ) [inherited]

Test if object reference is owned.

Definition at line 117 of file Object.cpp.

  {
    return _owns_the_reference;
  }

Here is the caller graph for this function:

virtual int nux::IOpenGLResource::RefCount ( ) const [inline, virtual]

Reimplemented in nux::IOpenGLVolume, and nux::IOpenGLSurface.

Definition at line 91 of file IOpenGLResource.h.

    {
      return GetReferenceCount();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

bool nux::Object::Reference ( ) [virtual, inherited]

Increase reference count.

Returns:
True if the object has successfully referenced.

Reimplemented from nux::Trackable.

Definition at line 254 of file Object.cpp.

  {
    if (!IsHeapAllocated())
    {
      LOG_WARN(logger) << "Trying to reference an object that was not heap allocated."
                       << "\nObject allocated at: " << GetAllocationLoation() << "\n";
      return false;
    }

    if (!OwnsTheReference())
    {
      SetOwnedReference(true);
      // The ref count remains at 1. Exit the method.
      return true;
    }

    reference_count_->Increment();
    return true;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

std::new_handler nux::Trackable::set_new_handler ( std::new_handler  handler) [static, inherited]

Definition at line 133 of file Object.cpp.

  {
    std::new_handler old_handler = _new_current_handler;
    _new_current_handler = handler;
    return old_handler;
  }

Here is the caller graph for this function:

void nux::Trackable::SetOwnedReference ( bool  b) [protected, inherited]

Definition at line 122 of file Object.cpp.

  {
    if (_owns_the_reference == true)
    {
      LOG_DEBUG(logger) << "Do not change the ownership if is already set to true!" << "\n";
      return;
    }

    _owns_the_reference = b;
  }

Here is the caller graph for this function:

bool nux::Introspectable::SetProperty ( std::string const &  name,
const char *  value 
) [inline, inherited]

If the property was not able to be set with the value, the method returns false.

Definition at line 262 of file Property-inl.h.

{
  PropertyContainer::iterator i = properties_.find(name);
  if (i == properties_.end())
    return false;
  else
    return i->second->SetValue(value);
}
template<typename T >
bool nux::Introspectable::SetProperty ( std::string const &  name,
T const &  value 
) [inherited]

Definition at line 273 of file Property-inl.h.

{
  PropertyContainer::iterator i = properties_.find(name);
  if (i == properties_.end())
    return false;
  else
  {
    return i->second->SetValue(type::PropertyTrait<T>::to_string(value));
  }
}
bool nux::Object::SinkReference ( ) [virtual, inherited]

Mark the object as owned.

If this object is not owned, calling SinkReference() as the same effect as calling Reference().

Returns:
True if the object was not owned previously

Reimplemented from nux::Trackable.

Definition at line 306 of file Object.cpp.

  {
    return Reference();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

bool nux::Object::UnReference ( ) [virtual, inherited]

Decrease reference count.

Returns:
True if the object reference count has reached 0 and the object has been destroyed.

Reimplemented from nux::Trackable.

Definition at line 274 of file Object.cpp.

  {
    if (!IsHeapAllocated())
    {
      LOG_WARN(logger) << "Trying to un-reference an object that was not heap allocated."
                       << "\nObject allocated at: " << GetAllocationLoation() << "\n";
      return false;
    }

    if (objectptr_count_->GetValue() == reference_count_->GetValue())
    {
      // There are ObjectPtr's hosting this object. Release all of them to
      // destroy this object.  This prevent from calling UnReference () many
      // times and destroying the object when there are ObjectPtr's hosting
      // it.  This method should not be called directly in that case.
      LOG_WARN(logger) << "There are ObjectPtr hosting this object. "
                       << "Release all of them to destroy this object. "
                       << "\nObject allocated at: " << GetAllocationLoation() << "\n";
      return false;
    }

    reference_count_->Decrement();

    if (reference_count_->GetValue() == 0)
    {
      Destroy();
      return true;
    }

    return false;
  }

Here is the call graph for this function:


Friends And Related Function Documentation

friend class GpuDevice [friend]
friend class IOpenGLAnimatedTexture [friend]

Reimplemented in nux::IOpenGLSurface.

Definition at line 116 of file IOpenGLResource.h.

friend class IOpenGLAsmPixelShader [friend]

Definition at line 131 of file IOpenGLResource.h.

friend class IOpenGLAsmShaderProgram [friend]

Definition at line 132 of file IOpenGLResource.h.

friend class IOpenGLAsmVertexShader [friend]

Definition at line 130 of file IOpenGLResource.h.

friend class IOpenGLBaseTexture [friend]

Definition at line 113 of file IOpenGLResource.h.

friend class IOpenGLCubeTexture [friend]

Reimplemented in nux::IOpenGLSurface.

Definition at line 114 of file IOpenGLResource.h.

friend class IOpenGLFrameBufferObject [friend]

Definition at line 111 of file IOpenGLResource.h.

friend class IOpenGLGeometryShader [friend]

Definition at line 128 of file IOpenGLResource.h.

friend class IOpenGLIndexBuffer [friend]

Definition at line 122 of file IOpenGLResource.h.

friend class IOpenGLPixelBufferObject [friend]

Definition at line 133 of file IOpenGLResource.h.

friend class IOpenGLPixelShader [friend]

Definition at line 127 of file IOpenGLResource.h.

friend class IOpenGLQuery [friend]

Definition at line 120 of file IOpenGLResource.h.

friend class IOpenGLRectangleTexture [friend]

Reimplemented in nux::IOpenGLSurface.

Definition at line 118 of file IOpenGLResource.h.

friend class IOpenGLShader [friend]

Definition at line 125 of file IOpenGLResource.h.

friend class IOpenGLShaderProgram [friend]

Definition at line 129 of file IOpenGLResource.h.

friend class IOpenGLSurface [friend]
friend class IOpenGLTexture2D [friend]

Reimplemented in nux::IOpenGLSurface.

Definition at line 117 of file IOpenGLResource.h.

friend class IOpenGLVertexBuffer [friend]

Definition at line 123 of file IOpenGLResource.h.

friend class IOpenGLVertexDeclaration [friend]

Definition at line 124 of file IOpenGLResource.h.

friend class IOpenGLVertexShader [friend]

Definition at line 126 of file IOpenGLResource.h.

friend class IOpenGLVolume [friend]

Reimplemented in nux::IOpenGLBaseTexture.

Definition at line 119 of file IOpenGLResource.h.

friend class IOpenGLVolumeTexture [friend]

Reimplemented in nux::IOpenGLSurface, and nux::IOpenGLVolume.

Definition at line 115 of file IOpenGLResource.h.


Member Data Documentation

int nux::Trackable::_heap_allocated [protected, inherited]

Definition at line 158 of file Object.h.

Definition at line 107 of file IOpenGLResource.h.

Definition at line 108 of file IOpenGLResource.h.

Definition at line 109 of file IOpenGLResource.h.

sigc::signal<void, Object *> nux::Object::object_destroyed [inherited]

Signal emitted immediately before the object is destroyed.

Definition at line 214 of file Object.h.


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