TalanSoft Toolkits  201707
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
iGraphicsDrawOpCapture Struct Referenceabstract
Inheritance diagram for iGraphicsDrawOpCapture:
iUnknown

Detailed Description

Draw operation capture object.

Public Member Functions

virtual tBool BeginCapture ()=0
 Begin capturing. More...
 
virtual tU32 EndCapture ()=0
 End capturing. More...
 
virtual tBool GetIsCapturing () const =0
 Return whether we the object is currently capturing. {Property}. More...
 
virtual void ClearCapture ()=0
 Clear all captured data. More...
 
virtual void SetCaptureFlags (tGraphicsCaptureFlags aFlags)=0
 Set the capture flags. {Property}. More...
 
virtual tGraphicsCaptureFlags GetCaptureFlags () const =0
 Get the capture flags. {Property}. More...
 
virtual void SetCaptureStopAt (tU32 anStopAt)=0
 Set the current stop at index. {Property}. More...
 
virtual tU32 GetCaptureStopAt () const =0
 Get the current stop at index. {Property}. More...
 
virtual tU32 GetNumCaptured () const =0
 Get the number of draw ops captured. {Property}. More...
 
virtual sVec4i GetCapturedClear (tU32 anIndex) const =0
 Get the captured clear operation parameters. {Property}. More...
 
virtual iDrawOperationGetCapturedDrawOp (tU32 anIndex) const =0
 Get the draw operation at the specified index. {Property}. More...
 
virtual tF32 GetCapturedDrawOpTime (tU32 anIndex) const =0
 Get the time taken to submit the specified draw operation {Property}. More...
 
virtual iGraphicsContextGetCapturedDrawOpContext (tU32 anIndex) const =0
 Get the context that submited the draw operation. {Property}. More...
 
virtual tBool BeginCaptureDrawOp (iGraphicsContext *apContext, iDrawOperation *apDrawOp, const sVec4i &aClearParams)=0
 Called to capture a draw operation. More...
 
virtual void EndCaptureDrawOp (iGraphicsContext *apContext, iDrawOperation *apDrawOp, const sVec4i &aClearParams)=0
 Called to finish the draw operation capture. More...
 
- Public Member Functions inherited from iUnknown
virtual tBool IsOK () const =0
 Check if the object is valid. More...
 
virtual tI32 AddRef ()=0
 Signal that one more reference of the object has been created. More...
 
virtual tI32 Release ()=0
 Release a reference of the object. More...
 
virtual void DeleteThis ()=0
 Bypass any reference counting and delete this object. More...
 
virtual void Invalidate ()=0
 Invalidate the object. More...
 
virtual iUnknownQueryInterface (const tUUID &aIID)=0
 Query an interface. More...
 
virtual void ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
 Fill a UUID list containing the UUIDs of the implemented interfaces. More...
 
virtual tI32 SetNumRefs (tI32 anNumRefs)=0
 Set the reference counter directly. More...
 
virtual tI32 GetNumRefs () const =0
 Get the number of references to this object. More...
 

Member Function Documentation

virtual tBool BeginCapture ( )
pure virtual

Begin capturing.

Remarks
DOES NOT clear the previous capture data.
virtual tU32 EndCapture ( )
pure virtual

End capturing.

Returns
The number of draw operations captured.
virtual tBool GetIsCapturing ( ) const
pure virtual

Return whether we the object is currently capturing. {Property}.

virtual void ClearCapture ( )
pure virtual

Clear all captured data.

virtual void SetCaptureFlags ( tGraphicsCaptureFlags  aFlags)
pure virtual

Set the capture flags. {Property}.

virtual tGraphicsCaptureFlags GetCaptureFlags ( ) const
pure virtual

Get the capture flags. {Property}.

virtual void SetCaptureStopAt ( tU32  anStopAt)
pure virtual

Set the current stop at index. {Property}.

virtual tU32 GetCaptureStopAt ( ) const
pure virtual

Get the current stop at index. {Property}.

virtual tU32 GetNumCaptured ( ) const
pure virtual

Get the number of draw ops captured. {Property}.

virtual sVec4i GetCapturedClear ( tU32  anIndex) const
pure virtual

Get the captured clear operation parameters. {Property}.

Remarks
The format is (ClearFlags,Color,ftoul(Depth),Stencil)
virtual iDrawOperation* GetCapturedDrawOp ( tU32  anIndex) const
pure virtual

Get the draw operation at the specified index. {Property}.

virtual tF32 GetCapturedDrawOpTime ( tU32  anIndex) const
pure virtual

Get the time taken to submit the specified draw operation {Property}.

virtual iGraphicsContext* GetCapturedDrawOpContext ( tU32  anIndex) const
pure virtual

Get the context that submited the draw operation. {Property}.

virtual tBool BeginCaptureDrawOp ( iGraphicsContext apContext,
iDrawOperation apDrawOp,
const sVec4i aClearParams 
)
pure virtual

Called to capture a draw operation.

Returns
eFalse if the draw operation should not be submitted.
virtual void EndCaptureDrawOp ( iGraphicsContext apContext,
iDrawOperation apDrawOp,
const sVec4i aClearParams 
)
pure virtual

Called to finish the draw operation capture.