From ebcace7cc8dd98e8d8ae1ffe3ef52e1ef68665d8 Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Sun, 3 Sep 2017 12:13:54 +0100 Subject: Updating docs --- hierarchy.html | 99 ++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 66 insertions(+), 33 deletions(-) (limited to 'hierarchy.html') diff --git a/hierarchy.html b/hierarchy.html index dae9b5da..77e2e4e4 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -87,38 +87,71 @@ $(document).ready(function(){initNavTree('hierarchy.html','');});
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 123]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼Cyage::Body
 Cyage::CollisionBody
 ▼Cyage::ParticleBody
 Cyage::RigidBody
 Cyage::Camera2D
 ▼Cyage::Collider
 Cyage::RectangleCollider
 Cyage::Color
 Cyage::GlslProgram
 Cyage::GlyphGlyph with information of the texture
 Cyage::ImageLoader
 Cyage::InputManager
 Cyage::IoManager
 Cyage::Matrix< Rows, Cols, Type >Base Matrix class used by other similar classes
 ▼Cyage::Matrix< Rows, 1, double >
 ▼Cyage::Vector< 2, double >
 Cyage::Vector2< double >
 ▼Cyage::Matrix< Rows, 1, Type >
 ▼Cyage::Vector< 2, Type >
 Cyage::Vector2< Type >2D Vector class
 Cyage::Vector< Rows, Type >
 Cyage::Position
 Cyage::RenderBatch
 Cyage::ResourceManager
 Cyage::detail::Row< Rows, Cols, Type >
 Cyage::Sprite
 Cyage::SpriteBatch
 Cyage::Texture
 Cyage::TextureCache
 Cyage::UV
 Cyage::Vertex
 Cyage::Window
 Crapidxml::xml_document< Ch >::attribute_name_pred
 Crapidxml::xml_document< Ch >::attribute_value_pred< Quote >
 Crapidxml::xml_document< Ch >::attribute_value_pure_pred< Quote >
 ▼Cyage::Body
 Cyage::CollisionBody
 ▼Cyage::ParticleBody
 Cyage::RigidBody
 Cyage::Camera2D
 ▼Cyage::Collider
 Cyage::RectangleCollider
 Cyage::Color
 ▼Cstd::exceptionSTL class
 Crapidxml::parse_errorParse error exception. This exception is thrown by the parser when an error occurs. Use what() function to get human-readable error message. Use where() function to get a pointer to position within source text where error was detected.
+
+ If throwing exceptions by the parser is undesirable, it can be disabled by defining RAPIDXML_NO_EXCEPTIONS macro before rapidxml.hpp is included. This will cause the parser to call rapidxml::parse_error_handler() function instead of throwing an exception. This function must be defined by the user.
+
+ This class derives from std::exception class
 Cyage::GlslProgram
 Cyage::GlyphGlyph with information of the texture
 Crapidxml::memory_pool< Ch >::header
 Cyage::ImageLoader
 Cyage::InputManager
 Cyage::IoManager
 Cyage::Matrix< Rows, Cols, Type >Base Matrix class used by other similar classes
 ▼Cyage::Matrix< Rows, 1, double >
 ▼Cyage::Vector< 2, double >
 Cyage::Vector2< double >
 ▼Cyage::Matrix< Rows, 1, Type >
 ▼Cyage::Vector< 2, Type >
 Cyage::Vector2< Type >2D Vector class
 Cyage::Vector< Rows, Type >
 ▼Crapidxml::memory_pool< Ch >This class is used by the parser to create new nodes and attributes, without overheads of dynamic memory allocation. In most cases, you will not need to use this class directly. However, if you need to create nodes manually or modify names/values of nodes, you are encouraged to use memory_pool of relevant xml_document to allocate the memory. Not only is this faster than allocating them by using new operator, but also their lifetime will be tied to the lifetime of document, possibly simplyfing memory management.
+
+ Call allocate_node() or allocate_attribute() functions to obtain new nodes or attributes from the pool. You can also call allocate_string() function to allocate strings. Such strings can then be used as names or values of nodes without worrying about their lifetime. Note that there is no free() function – all allocations are freed at once when clear() function is called, or when the pool is destroyed.
+
+ It is also possible to create a standalone memory_pool, and use it to allocate nodes, whose lifetime will not be tied to any document.
+
+ Pool maintains RAPIDXML_STATIC_POOL_SIZE bytes of statically allocated memory. Until static memory is exhausted, no dynamic memory allocations are done. When static memory is exhausted, pool allocates additional blocks of memory of size RAPIDXML_DYNAMIC_POOL_SIZE each, by using global new[] and delete[] operators. This behaviour can be changed by setting custom allocation routines. Use set_allocator() function to set them.
+
+ Allocations for nodes, attributes and strings are aligned at RAPIDXML_ALIGNMENT bytes. This value defaults to the size of pointer on target architecture.
+
+ To obtain absolutely top performance from the parser, it is important that all nodes are allocated from a single, contiguous block of memory. Otherwise, cache misses when jumping between two (or more) disjoint blocks of memory can slow down parsing quite considerably. If required, you can tweak RAPIDXML_STATIC_POOL_SIZE, RAPIDXML_DYNAMIC_POOL_SIZE and RAPIDXML_ALIGNMENT to obtain best wasted memory to performance compromise. To do it, define their values before rapidxml.hpp file is included
 Crapidxml::xml_document< Ch >This class represents root of the DOM hierarchy. It is also an xml_node and a memory_pool through public inheritance. Use parse() function to build a DOM tree from a zero-terminated XML text string. parse() function allocates memory for nodes and attributes by using functions of xml_document, which are inherited from memory_pool. To access root node of the document, use the document itself, as if it was an xml_node
 Crapidxml::xml_document< Ch >::node_name_pred
 Cyage::Position
 Cyage::RenderBatch
 Cyage::ResourceManager
 Cyage::detail::Row< Rows, Cols, Type >
 Cyage::Sprite
 Cyage::SpriteBatch
 Crapidxml::xml_document< Ch >::text_pred
 Crapidxml::xml_document< Ch >::text_pure_no_ws_pred
 Crapidxml::xml_document< Ch >::text_pure_with_ws_pred
 Cyage::Texture
 Cyage::TextureCache
 Cyage::UV
 Cyage::Vertex
 Crapidxml::xml_document< Ch >::whitespace_pred
 Cyage::Window
 ▼Crapidxml::xml_base< Ch >Base class for xml_node and xml_attribute implementing common functions: name(), name_size(), value(), value_size() and parent()
 Crapidxml::xml_attribute< Ch >Class representing attribute node of XML document. Each attribute has name and value strings, which are available through name() and value() functions (inherited from xml_base). Note that after parse, both name and value of attribute will point to interior of source text used for parsing. Thus, this text must persist in memory for the lifetime of attribute
 ▼Crapidxml::xml_node< Ch >Class representing a node of XML document. Each node may have associated name and value strings, which are available through name() and value() functions. Interpretation of name and value depends on type of the node. Type of node can be determined by using type() function.
+
+ Note that after parse, both name and value of node, if any, will point interior of source text used for parsing. Thus, this text must persist in the memory for the lifetime of node
 Crapidxml::xml_document< Ch >This class represents root of the DOM hierarchy. It is also an xml_node and a memory_pool through public inheritance. Use parse() function to build a DOM tree from a zero-terminated XML text string. parse() function allocates memory for nodes and attributes by using functions of xml_document, which are inherited from memory_pool. To access root node of the document, use the document itself, as if it was an xml_node
@@ -126,7 +159,7 @@ $(document).ready(function(){initNavTree('hierarchy.html','');});