Rebel Fork Framework
Urho3D::OcclusionBuffer Class Reference

Software renderer for occlusion. More...

#include <Urho3D/Graphics/OcclusionBuffer.h>

Inheritance diagram for Urho3D::OcclusionBuffer:
Urho3D::Object Urho3D::RefCounted

Public Member Functions

 OcclusionBuffer (Context *context)
 ~OcclusionBuffer () override
bool SetSize (int width, int height, bool threaded)
 Set occlusion buffer size and whether to reserve multiple buffers for threading optimization.
void SetView (Camera *camera)
 Set camera view to render from.
void SetMaxTriangles (unsigned triangles)
 Set maximum triangles to render.
void SetCullMode (CullMode mode)
 Set culling mode.
void Reset ()
 Reset number of triangles.
void Clear ()
 Clear the buffer.
bool AddTriangles (const Matrix3x4 &model, const void *vertexData, unsigned vertexSize, unsigned vertexStart, unsigned vertexCount)
 Submit a triangle mesh to the buffer using non-indexed geometry. Return true if did not overflow the allowed triangle count.
bool AddTriangles (const Matrix3x4 &model, const void *vertexData, unsigned vertexSize, const void *indexData, unsigned indexSize, unsigned indexStart, unsigned indexCount)
 Submit a triangle mesh to the buffer using indexed geometry. Return true if did not overflow the allowed triangle count.
void DrawTriangles ()
 Draw submitted batches. Uses worker threads if enabled during SetSize().
void BuildDepthHierarchy ()
 Build reduced size mip levels.
void ResetUseTimer ()
 Reset last used timer.
int * GetBuffer () const
 Return highest level depth values.
const Matrix3x4GetView () const
 Return view transform matrix.
const Matrix4GetProjection () const
 Return projection matrix.
int GetWidth () const
 Return buffer width.
int GetHeight () const
 Return buffer height.
unsigned GetNumTriangles () const
 Return number of rendered triangles.
unsigned GetMaxTriangles () const
 Return maximum number of triangles.
CullMode GetCullMode () const
 Return culling mode.
bool IsThreaded () const
 Return whether is using threads to speed up rendering.
bool IsVisible (const BoundingBox &worldSpaceBox) const
 Test a bounding box for visibility. For best performance, build depth hierarchy first.
unsigned GetUseTimer ()
 Return time since last use in milliseconds.
void DrawBatch (const OcclusionBatch &batch, unsigned threadIndex)
 Draw a batch. Called internally.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
virtual const ea::string & GetTypeName () const =0
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
bool IsInstanceOf (StringHash type) const
 Check current instance is type of specified type.
bool IsInstanceOf (const TypeInfo *typeInfo) const
 Check current instance is type of specified type.
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
void SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T handler)
 Subscribe to a specific sender's event.
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
void UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
void SendEvent (StringHash eventType)
 Send event to all subscribers.
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void SendEvent (StringHash eventType, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
ContextGetContext () const
 Return execution context.
const VariantGetGlobalVar (StringHash key) const
const VariantMapGetGlobalVars () const
void SetGlobalVar (StringHash key, const Variant &value)
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () const
 Return active event handler. Null outside event handling.
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
bool HasEventHandlers () const
 Return whether has subscribed to any event.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
const ea::string & GetCategory () const
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
int AddRef ()
int ReleaseRef ()
int Refs () const
int WeakRefs () const
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
bool IsScriptStrongRef () const
 Return true if script reference is strong.

Static Public Member Functions

static void RegisterObject (Context *context)
 Register object with the engine.
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.

Private Member Functions

 URHO3D_OBJECT (OcclusionBuffer, Object)
Vector4 ModelTransform (const Matrix4 &transform, const Vector3 &vertex) const
 Apply modelview transform to vertex.
Vector3 ViewportTransform (const Vector4 &vertex) const
 Apply projection and viewport transform to vertex.
Vector4 ClipEdge (const Vector4 &v0, const Vector4 &v1, float d0, float d1) const
 Clip an edge.
float SignedArea (const Vector3 &v0, const Vector3 &v1, const Vector3 &v2) const
 Return signed area of a triangle. If negative, is clockwise.
void CalculateViewport ()
 Calculate viewport transform.
void DrawTriangle (Vector4 *vertices, unsigned threadIndex)
 Draw a triangle.
void ClipVertices (const Vector4 &plane, Vector4 *vertices, bool *triangles, unsigned &numTriangles)
 Clip vertices against a plane.
void DrawTriangle2D (const Vector3 *vertices, bool clockwise, unsigned threadIndex)
 Draw a clipped triangle.
void ClearBuffer (unsigned threadIndex)
 Clear a thread work buffer.
void MergeBuffers ()
 Merge thread work buffers into the first buffer.

Private Attributes

ea::vector< OcclusionBufferDatabuffers_
 Highest-level buffer data per thread.
ea::vector< ea::shared_array< DepthValue > > mipBuffers_
 Reduced size depth buffers.
ea::vector< OcclusionBatchbatches_
 Submitted render jobs.
int width_ {}
 Buffer width.
int height_ {}
 Buffer height.
unsigned numTriangles_ {}
 Number of rendered triangles.
 Maximum number of triangles.
CullMode cullMode_ {CULL_CCW}
 Culling mode.
bool depthHierarchyDirty_ {true}
 Depth hierarchy needs update flag.
bool reverseCulling_ {}
 Culling reverse flag.
Matrix3x4 view_
 View transform matrix.
Matrix4 projection_
 Projection matrix.
Matrix4 viewProj_
 Combined view and projection matrix.
Timer useTimer_
 Last used timer.
float nearClip_ {}
 Near clip distance.
float farClip_ {}
 Far clip distance.
float scaleX_ {}
 X scaling for viewport transform.
float scaleY_ {}
 Y scaling for viewport transform.
float offsetX_ {}
 X offset for viewport transform.
float offsetY_ {}
 Y offset for viewport transform.
float projOffsetScaleX_ {}
 Combined X projection and viewport transform.
float projOffsetScaleY_ {}
 Combined Y projection and viewport transform.

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.

Detailed Description

Software renderer for occlusion.

The documentation for this class was generated from the following files: