CBaseControlVideo::GetSourceRect

Microsoft DirectShow 9.0

CBaseControlVideo::GetSourceRect

The GetSourceRect method retrieves the source rectangle. This is an internal method.

Syntax

  virtual HRESULT GetSourceRect(
    RECT *pSourceRect
) PURE;

Parameters

pSourceRect

Pointer to the retrieved source rectangle.

Return Value

Returns an HRESULT value.

Remarks

This member function must be overridden in the derived class to return the source rectangle held by the video renderer. It is called from the following CBaseControlVideo member functions.

• CBaseControlVideo::GetSourcePosition
• CBaseControlVideo::put_SourceLeft
• CBaseControlVideo::get_SourceLeft
• CBaseControlVideo::put_SourceWidth
• CBaseControlVideo::get_SourceWidth
• CBaseControlVideo::put_SourceTop
• CBaseControlVideo::get_SourceTop
• CBaseControlVideo::put_SourceHeight
• CBaseControlVideo::get_SourceHeight

The following example demonstrates an implementation of this function in a derived class.

// Return the current source rectangle
HRESULT CVideoText::GetSourceRect(RECT *pSourceRect)
{
    ASSERT(pSourceRect);
    m_pRenderer->m_DrawImage.GetSourceRect(pSourceRect);
    return NOERROR;
}

In this example, CVideoText is a class derived from CBaseControlVideo, m_pRenderer holds an object of a class derived from CBaseVideoRenderer, and the m_DrawImage data member, defined in the derived class, holds a CDrawImage object.

Requirements

**  Header:** Declared in Ctlutil.h; include Streams.h.

**  Library:** Use Strmbase.lib (retail builds) or Strmbasd.lib (debug builds).

See Also

• CBaseControlVideo Class