Torque3D/Engine/source/gfx/gfxFence.h
marauder2k7 efbe5e90f5 virtuals removed
virtuals removed and replaced with override where necessary, clang-tidy to the rescue.
2024-03-18 18:13:00 +00:00

105 lines
3.2 KiB
C++

//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------
#ifndef _GFXFENCE_H_
#define _GFXFENCE_H_
#ifndef _GFXDEVICE_H_
#include "gfx/gfxDevice.h"
#endif
///
class GFXFence : public GFXResource
{
protected:
GFXDevice *mDevice;
public:
/// The states returned by getStatus()
enum FenceStatus
{
Unset, ///< The fence has not been set
Pending, ///< The fence has been set and has not been hit
Processed, ///< The fence has been processed
Unsupported ///< A non-blocking query of fence status is not supported by the implementation
};
public:
GFXFence( GFXDevice *device ) : mDevice( device ) {};
virtual ~GFXFence(){};
/// This method inserts the fence into the command buffer
virtual void issue() = 0;
// CodeReview: Do we need a remove() [5/10/2007 Pat]
/// This is a non-blocking call to get the status of the fence
/// @see GFXFence::FenceStatus
virtual FenceStatus getStatus() const = 0;
/// This method will not return until the fence has been processed by the GPU
virtual void block() = 0;
};
///
class GFXGeneralFence : public GFXFence
{
protected:
bool mInitialized;
GFXTextureTargetRef mRenderTarget;
GFXTexHandle mRTTexHandle;
GFXStateBlockRef mRenderSB;
void _init();
/// The callback used to get texture events.
/// @see GFXTextureManager::addEventDelegate
void _onTextureEvent( GFXTexCallbackCode code );
public:
GFXGeneralFence( GFXDevice *device )
: GFXFence( device ),
mInitialized( false )
{
}
virtual ~GFXGeneralFence();
void issue() override;
FenceStatus getStatus() const override { return GFXFence::Unsupported; };
void block() override;
// GFXResource interface
void zombify() override;
void resurrect() override;
/// The resource should put a description of itself (number of vertices, size/width of texture, etc.) in buffer
const String describeSelf() const override;
};
#endif // _GFXFENCE_H_