occlusion_query.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Harry Storbacka
00027 */
00028 
00031 
00032 #pragma once
00033 
00034 #include "../api_display.h"
00035 #include "../../Core/System/sharedptr.h"
00036 #include "graphic_context.h"
00037 
00038 class CL_OcclusionQuery_Impl;
00039 class CL_GraphicContext;
00040 class CL_OcclusionQueryProvider;
00041 
00045 class CL_API_DISPLAY CL_OcclusionQuery
00046 {
00049 
00050 public:
00052         CL_OcclusionQuery();
00053 
00055         CL_OcclusionQuery(CL_GraphicContext &context);
00056 
00057         virtual ~CL_OcclusionQuery();
00058 
00062 
00063 public:
00065         bool is_null() const { return !impl; }
00066 
00068         void throw_if_null() const;
00069 
00071         int get_result();
00072 
00074         bool is_result_ready();
00075 
00079         CL_OcclusionQueryProvider *get_provider() const;
00080 
00084 
00085 public:
00087         void begin();
00088 
00090         void end();
00091 
00095 
00096 private:
00097         CL_SharedPtr<CL_OcclusionQuery_Impl> impl;
00099 };
00100