program_attribute.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 **    Magnus Norddahl
00027 **    Harry Storbacka
00028 */
00029 
00032 
00033 #pragma once
00034 
00035 #include "../api_display.h"
00036 #include "../../Core/System/sharedptr.h"
00037 #include "../../Core/Text/string_types.h"
00038 
00039 class CL_ProgramAttribute_Impl;
00040 
00044 class CL_API_DISPLAY CL_ProgramAttribute
00045 {
00048 
00049 public:
00051         CL_ProgramAttribute();
00052 
00059         CL_ProgramAttribute(const CL_StringRef &name, int size, int type, int location);
00060 
00061         ~CL_ProgramAttribute();
00062 
00066 
00067 public:
00069         bool is_null() const { return !impl; }
00070 
00072         void throw_if_null() const;
00073 
00075         CL_StringRef get_name() const;
00076 
00078         int get_size() const;
00079 
00081         int get_type() const;
00082 
00084         int get_location() const;
00085 
00089 
00090 public:
00091 
00095 
00096 private:
00097         CL_SharedPtr<CL_ProgramAttribute_Impl> impl;
00099 };
00100