// Created on: 2011-03-18
// Created by: Anton POLETAEV
-// Copyright (c) 2011-2012 OPEN CASCADE SAS
+// Copyright (c) 2011-2014 OPEN CASCADE SAS
//
-// The content of this file is subject to the Open CASCADE Technology Public
-// License Version 6.5 (the "License"). You may not use the content of this file
-// except in compliance with the License. Please obtain a copy of the License
-// at http://www.opencascade.org and read it completely before using this file.
+// This file is part of Open CASCADE Technology software library.
//
-// The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-// main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
+// This library is free software; you can redistribute it and/or modify it under
+// the terms of the GNU Lesser General Public License version 2.1 as published
+// by the Free Software Foundation, with special exception defined in the file
+// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+// distribution for complete text of the license and disclaimer of any warranty.
//
-// The Original Code and all software distributed under the License is
-// distributed on an "AS IS" basis, without warranty of any kind, and the
-// Initial Developer hereby disclaims all such warranties, including without
-// limitation, any warranties of merchantability, fitness for a particular
-// purpose or non-infringement. Please see the License for the specific terms
-// and conditions governing the rights and limitations under the License.
+// Alternatively, this file may be used under the terms of Open CASCADE
+// commercial license or contractual agreement.
+#ifndef _OpenGl_Resource_H__
+#define _OpenGl_Resource_H__
-#ifndef _OPENGL_RESOURCE_H
-#define _OPENGL_RESOURCE_H
-
-#include <OpenGl_GlCore11.hxx>
-
-#include <OpenGl_ResourceCleaner.hxx>
-#include <MMgt_TShared.hxx>
-#include <Handle_MMgt_TShared.hxx>
+#include <Standard_Type.hxx>
class Standard_Transient;
-class Handle(Standard_Type);
-class Handle(MMgt_TShared);
-class Handle(OpenGl_Context);
-class OpenGl_ResourceCleaner;
-
-//! Class represents basic OpenGl memory resource, which
-//! could be removed only if appropriate context is avaliable;
-//! The cleaning procedure is done by OpenGl_ResourceCleaner
-class OpenGl_Resource : public MMgt_TShared
+class OpenGl_Context;
+
+//! Interface for OpenGl resource with following meaning:
+//! - object can be constructed at any time;
+//! - should be explicitly Initialized within active OpenGL context;
+//! - should be explicitly Released within active OpenGL context (virtual Release() method);
+//! - can be destroyed at any time.
+//! Destruction of object with unreleased GPU resources will cause leaks
+//! which will be ignored in release mode and will immediately stop program execution in debug mode using assert.
+class OpenGl_Resource : public Standard_Transient
{
public:
- //! Constructor
- OpenGl_Resource() : myId(0) { }
-
- //! Constructor
- OpenGl_Resource(GLuint theId) : myId(theId) { }
-
- //! Destructor
- virtual ~OpenGl_Resource() {}
+ //! Empty constructor
+ Standard_EXPORT OpenGl_Resource();
- //! method clean() is accessible only by OpenGl_ResourceCleaner
- friend class OpenGl_ResourceCleaner;
+ //! Destructor. Inheritors should call Clean (NULL) within it.
+ Standard_EXPORT virtual ~OpenGl_Resource();
-protected:
+ //! Release GPU resources.
+ //! Notice that implementation should be SAFE for several consecutive calls
+ //! (thus should invalidate internal structures / ids to avoid multiple-free errors).
+ //! @param theGlCtx - bound GL context, shouldn't be NULL.
+ Standard_EXPORT virtual void Release (OpenGl_Context* theGlCtx) = 0;
- //! Clean procedure, should be called only by OpenGl_ResourceCleaner;
- //! Each type of resource has its own cleaning procedure
- virtual void Clean (const Handle(OpenGl_Context)& theGlContext) = 0;
+ //! Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.
+ virtual Standard_Size EstimatedDataSize() const = 0;
-protected:
+private:
- GLuint myId; // Id of OpenGl memory resource
+ //! Copy should be performed only within Handles!
+ OpenGl_Resource (const OpenGl_Resource& );
+ OpenGl_Resource& operator= (const OpenGl_Resource& );
public:
- DEFINE_STANDARD_RTTI(OpenGl_Resource) // Type definition
+ DEFINE_STANDARD_RTTIEXT(OpenGl_Resource,Standard_Transient) // Type definition
};
-DEFINE_STANDARD_HANDLE(OpenGl_Resource,MMgt_TShared)
+DEFINE_STANDARD_HANDLE(OpenGl_Resource, Standard_Transient)
-#endif
+#endif // _OpenGl_Resource_H__