Abstract class that can be implemented by the user application to provide a way to retrieve or generate page data from a source of their choosing.
More...
#include <OgrePageManager.h>
Abstract class that can be implemented by the user application to provide a way to retrieve or generate page data from a source of their choosing.
- Note
- All of the methods in this class can be called in a background, non-render thread.
◆ PageProvider()
Ogre::PageProvider::PageProvider |
( |
| ) |
|
|
inline |
◆ ~PageProvider()
virtual Ogre::PageProvider::~PageProvider |
( |
| ) |
|
|
inlinevirtual |
◆ prepareProceduralPage()
Give a provider the opportunity to prepare page content procedurally.
This call may well happen in a separate thread so it should not access GPU resources, use loadProceduralPage for that
- Returns
- true if the page was populated, false otherwise
◆ loadProceduralPage()
Give a provider the opportunity to load page content procedurally.
This call will happen in the main render thread so it can access GPU resources. Use prepareProceduralPage for background preparation.
- Returns
- true if the page was populated, false otherwise
◆ unloadProceduralPage()
Give a provider the opportunity to unload page content procedurally.
You should not call this method directly. This call will happen in the main render thread so it can access GPU resources. Use _unprepareProceduralPage for background preparation.
- Returns
- true if the page was populated, false otherwise
◆ unprepareProceduralPage()
Give a provider the opportunity to unprepare page content procedurally.
You should not call this method directly. This call may well happen in a separate thread so it should not access GPU resources, use _unloadProceduralPage for that
- Returns
- true if the page was unpopulated, false otherwise
◆ readWorldStream()
Get a serialiser set up to read PagedWorld data for the given world filename.
The StreamSerialiser returned is the responsibility of the caller to delete.
◆ writeWorldStream()
Get a serialiser set up to write PagedWorld data for the given world filename.
The StreamSerialiser returned is the responsibility of the caller to delete.
◆ readPageStream()
Get a serialiser set up to read Page data for the given PageID, or null if this provider cannot supply one.
The StreamSerialiser returned is the responsibility of the caller to delete.
- Parameters
-
pageID | The ID of the page being requested |
section | The parent section to which this page will belong |
◆ writePageStream()
Get a serialiser set up to write Page data for the given PageID, or null if this provider cannot supply one.
The StreamSerialiser returned is the responsibility of the caller to delete.
- Parameters
-
pageID | The ID of the page being requested |
section | The parent section to which this page will belong |
The documentation for this class was generated from the following file: