TViewport Class Reference

#include <TViewport.h>

Public Types
enum	ChangeEvent_ : ChangeEvent {   ChangeEvent_BackgroundColor , ChangeEvent_MaxZ , ChangeEvent_MinZ , ChangeEvent_Height ,   ChangeEvent_Width , ChangeEvent_X , ChangeEvent_Y , ChangeEvent_AllocatorBlock ,   ChangeEvent_BackgroundClear , ChangeEvent_DepthClear }
using	ChangeEvent = TUINT32

Public Member Functions
	TViewport (TBOOL a_bFlag)
virtual	~TViewport ()
virtual void	BeginSKU ()
virtual void	EndSKU ()
virtual void	ChangeSKU (ChangeEvent a_eEvent)
TFLOAT	GetX () const
TFLOAT	GetY () const
TFLOAT	GetWidth () const
TFLOAT	GetHeight () const
void	Begin ()
void	End ()
TBOOL	AllowBackgroundClear (TBOOL allow)
TBOOL	AllowDepthClear (TBOOL allow)
void	Enable (TBOOL enable)
TBOOL	EnableDefaultBeginRender (TBOOL enable)
void	SetMemoryAllocatorBlock (TMemory::MemBlock *a_pMemBlock)
void	SetX (TFLOAT value)
void	SetY (TFLOAT value)
void	SetWidth (TFLOAT value)
void	SetHeight (TFLOAT value)
void	SetMinZ (TFLOAT value)
void	SetMaxZ (TFLOAT value)
TRenderContext *	GetRenderContext () const
void	SetBackgroundColor (TUINT8 r, TUINT8 g, TUINT8 b, TUINT8 a)
void	GetBackgroundColor (TUINT8 &r, TUINT8 &g, TUINT8 &b, TUINT8 &a)

Detailed Description

Definition at line 7 of file TViewport.h.

Member Typedef Documentation

ChangeEvent

using TViewport::ChangeEvent = TUINT32

Definition at line 10 of file TViewport.h.

Member Enumeration Documentation

ChangeEvent_

enum TViewport::ChangeEvent_ : ChangeEvent

Enumerator
ChangeEvent_BackgroundColor
ChangeEvent_MaxZ
ChangeEvent_MinZ
ChangeEvent_Height
ChangeEvent_Width
ChangeEvent_X
ChangeEvent_Y
ChangeEvent_AllocatorBlock
ChangeEvent_BackgroundClear
ChangeEvent_DepthClear

Definition at line 11 of file TViewport.h.

    {
        ChangeEvent_BackgroundColor,
        ChangeEvent_MaxZ,
        ChangeEvent_MinZ,
        ChangeEvent_Height,
        ChangeEvent_Width,
        ChangeEvent_X,
        ChangeEvent_Y,
        ChangeEvent_AllocatorBlock,
        ChangeEvent_BackgroundClear,
        ChangeEvent_DepthClear,
    };

Constructor & Destructor Documentation

TViewport()

TViewport::TViewport

(

TBOOL

a_bFlag

)

Definition at line 12 of file TViewport.cpp.

{
    m_MemAllocatorBlock     = TNULL;
    m_pRenderCtx            = TRenderInterface::GetSingleton()->CreateRenderContext();
    m_ColorR                = 0;
    m_ColorG                = 0;
    m_ColorB                = 0;
    m_ColorA                = 0;
    m_bAllowBackgroundClear = TTRUE;
    m_bAllowDepthClear      = TTRUE;
    m_bDefaultBeginRender   = TTRUE;
    m_bEnable               = TTRUE;
    m_bInViewport           = TFALSE;
 
    SetWidth( -1.0f );
    SetHeight( -1.0f );
 
    if ( a_bFlag )
    {
        TRenderInterface::GetSingleton()->Unknown1( this );
    }
}

~TViewport()

TViewport::~TViewport ( )

virtual

Definition at line 35 of file TViewport.cpp.

{
    if ( m_pRenderCtx )
    {
        delete m_pRenderCtx;
        m_pRenderCtx = TNULL;
    }
}

Member Function Documentation

AllowBackgroundClear()

TBOOL TViewport::AllowBackgroundClear

(

TBOOL

allow

)

Definition at line 168 of file TViewport.cpp.

{
    TBOOL oldState          = m_bAllowBackgroundClear;
    m_bAllowBackgroundClear = allow;
    ChangeSKU( ChangeEvent_BackgroundClear );
    return oldState;
}

AllowDepthClear()

TBOOL TViewport::AllowDepthClear

(

TBOOL

allow

)

Definition at line 160 of file TViewport.cpp.

{
    TBOOL oldState     = m_bAllowDepthClear;
    m_bAllowDepthClear = allow;
    ChangeSKU( ChangeEvent_DepthClear );
    return oldState;
}

Begin()

void TViewport::Begin

(

)

Definition at line 183 of file TViewport.cpp.

{
    TASSERT( m_bInViewport == TFALSE );
    m_bInViewport = TTRUE;
    BeginSKU();
}

BeginSKU()

void TViewport::BeginSKU ( )

virtual

Definition at line 14 of file TViewport_DX8.cpp.

{
    D3DVIEWPORT8 viewport;
    viewport.X      = DWORD( m_pRenderCtx->GetViewportParameters().fX );
    viewport.Y      = DWORD( m_pRenderCtx->GetViewportParameters().fY );
    viewport.Width  = DWORD( m_pRenderCtx->GetViewportParameters().fWidth );
    viewport.Height = DWORD( m_pRenderCtx->GetViewportParameters().fHeight );
    viewport.MinZ   = 0.0f;
    viewport.MaxZ   = 1.0f;
 
    TUINT8 r, g, b, a;
    GetBackgroundColor( r, g, b, a );
 
    auto pRender    = TSTATICCAST( TRenderD3DInterface, TRenderInterface::GetSingleton() );
    auto pD3DDevice = pRender->GetDirect3DDevice();
 
    pD3DDevice->SetViewport( &viewport );
 
    TUINT eClearFlags = ( ( m_bAllowDepthClear != TTRUE ) - 1U & 2 | m_bAllowBackgroundClear == TTRUE );
 
    if ( eClearFlags != 0 )
    {
        pRender->ClearRegion(
            DWORD( m_pRenderCtx->GetViewportParameters().fX ),
            DWORD( m_pRenderCtx->GetViewportParameters().fY ),
            DWORD( m_pRenderCtx->GetViewportParameters().fWidth ),
            DWORD( m_pRenderCtx->GetViewportParameters().fHeight ),
            eClearFlags,
            r,
            g,
            b,
            1.0f,
            0
        );
    }
}

ChangeSKU()

void TViewport::ChangeSKU ( ChangeEvent a_eEvent )

virtual

Definition at line 57 of file TViewport_DX8.cpp.

{
}

Enable()

void TViewport::Enable

(

TBOOL

enable

)

Definition at line 155 of file TViewport.cpp.

{
    m_bEnable = enable;
}

EnableDefaultBeginRender()

TBOOL TViewport::EnableDefaultBeginRender

(

TBOOL

enable

)

Definition at line 148 of file TViewport.cpp.

{
    TBOOL oldState        = m_bDefaultBeginRender;
    m_bDefaultBeginRender = enable;
    return oldState;
}

End()

void TViewport::End

(

)

Definition at line 176 of file TViewport.cpp.

{
    EndSKU();
    TASSERT( m_bInViewport == TTRUE );
    m_bInViewport = TFALSE;
}

EndSKU()

void TViewport::EndSKU ( )

virtual

Definition at line 52 of file TViewport_DX8.cpp.

{
    TRenderInterface::GetSingleton()->FlushOrderTables();
}

GetBackgroundColor()

void TViewport::GetBackgroundColor	(	TUINT8 &	r,
		TUINT8 &	g,
		TUINT8 &	b,
		TUINT8 &	a )

Definition at line 57 of file TViewport.cpp.

{
    r = m_ColorR;
    g = m_ColorG;
    b = m_ColorB;
    a = m_ColorA;
}

GetHeight()

TFLOAT TViewport::GetHeight

(

)

const

Definition at line 190 of file TViewport.cpp.

{
    return m_pRenderCtx->GetHeight();
}

GetRenderContext()

TRenderContext * TViewport::GetRenderContext

(

)

const

Definition at line 65 of file TViewport.cpp.

{
    return m_pRenderCtx;
}

GetWidth()

TFLOAT TViewport::GetWidth

(

)

const

Definition at line 195 of file TViewport.cpp.

{
    return m_pRenderCtx->GetWidth();
}

GetX()

TFLOAT TViewport::GetX

(

)

const

Definition at line 205 of file TViewport.cpp.

{
    return m_pRenderCtx->GetX();
}

GetY()

TFLOAT TViewport::GetY

(

)

const

Definition at line 200 of file TViewport.cpp.

{
    return m_pRenderCtx->GetY();
}

SetBackgroundColor()

void TViewport::SetBackgroundColor	(	TUINT8	r,
		TUINT8	g,
		TUINT8	b,
		TUINT8	a )

Definition at line 44 of file TViewport.cpp.

{
    if ( m_ColorR != r || m_ColorG != g || m_ColorB != b || m_ColorA != a )
    {
        m_ColorR = r;
        m_ColorG = g;
        m_ColorB = b;
        m_ColorA = a;
 
        ChangeSKU( ChangeEvent_BackgroundColor );
    }
}

SetHeight()

void TViewport::SetHeight

(

TFLOAT

value

)

Definition at line 94 of file TViewport.cpp.

{
    TRenderContext::VIEWPORTPARAMS params = m_pRenderCtx->GetViewportParameters();
 
    if ( params.fHeight != value )
    {
        params.fHeight = value;
        m_pRenderCtx->SetViewportParameters( params );
        ChangeSKU( ChangeEvent_Height );
    }
}

SetMaxZ()

void TViewport::SetMaxZ

(

TFLOAT

value

)

Definition at line 70 of file TViewport.cpp.

{
    TRenderContext::VIEWPORTPARAMS params = m_pRenderCtx->GetViewportParameters();
 
    if ( params.fMaxZ != value )
    {
        params.fMaxZ = value;
        m_pRenderCtx->SetViewportParameters( params );
        ChangeSKU( ChangeEvent_MaxZ );
    }
}

SetMemoryAllocatorBlock()

void TViewport::SetMemoryAllocatorBlock

(

TMemory::MemBlock *

a_pMemBlock

)

Definition at line 142 of file TViewport.cpp.

{
    m_MemAllocatorBlock = a_pMemBlock;
    ChangeSKU( ChangeEvent_AllocatorBlock );
}

SetMinZ()

void TViewport::SetMinZ

(

TFLOAT

value

)

Definition at line 82 of file TViewport.cpp.

{
    TRenderContext::VIEWPORTPARAMS params = m_pRenderCtx->GetViewportParameters();
 
    if ( params.fMinZ != value )
    {
        params.fMinZ = value;
        m_pRenderCtx->SetViewportParameters( params );
        ChangeSKU( ChangeEvent_MinZ );
    }
}

SetWidth()

void TViewport::SetWidth

(

TFLOAT

value

)

Definition at line 106 of file TViewport.cpp.

{
    TRenderContext::VIEWPORTPARAMS params = m_pRenderCtx->GetViewportParameters();
 
    if ( params.fWidth != value )
    {
        params.fWidth = value;
        m_pRenderCtx->SetViewportParameters( params );
        ChangeSKU( ChangeEvent_Width );
    }
}

SetX()

void TViewport::SetX

(

TFLOAT

value

)

Definition at line 130 of file TViewport.cpp.

{
    TRenderContext::VIEWPORTPARAMS params = m_pRenderCtx->GetViewportParameters();
 
    if ( params.fX != value )
    {
        params.fX = value;
        m_pRenderCtx->SetViewportParameters( params );
        ChangeSKU( ChangeEvent_X );
    }
}

SetY()

void TViewport::SetY

(

TFLOAT

value

)

Definition at line 118 of file TViewport.cpp.

{
    TRenderContext::VIEWPORTPARAMS params = m_pRenderCtx->GetViewportParameters();
 
    if ( params.fY != value )
    {
        params.fY = value;
        m_pRenderCtx->SetViewportParameters( params );
        ChangeSKU( ChangeEvent_Y );
    }
}

---

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

• D:/_dev/OpenBarnyard/Source/Toshi/Source/Render/TViewport.h
• D:/_dev/OpenBarnyard/Source/Toshi/Source/Platform/DX8/TViewport_DX8.cpp
• D:/_dev/OpenBarnyard/Source/Toshi/Source/Render/TViewport.cpp