FALCON/EAGLE user manual 4.62

Syntax

INT is_DirectRenderer (HIDS hCam, UINT nMode, void* pParam, UINT nSize)

Description

is_DirectRenderer() provides a set of advanced rendering functions and allows inserting overlay data into the camera's live image without flicker. The graphics card functions of the Direct3D library are supported under Windows.

•A current version of Microsoft’s DirectX9 runtime environment has to be installed on the system in order to be able to use Direct3D functions. For installation packages search the Microsoft website for "DirectX end user runtime".

•The graphics card must support a texture size (i.e. overlay size) of at least 768 x 576 pixels for PAL and 649 x 480 pixels for NTSC, respectively. You can read out the maximum texture size using the DR_GET_MAX_OVERLAY_SIZE parameter.

•To enable the Direct3D display call
is_SetDisplayMode(h, IS_SET_DM_DIRECT3D)

•Several different color modes can be used for image display in Direct3D mode. However, the highest performance is achieved when the FALCON color mode is identical to the Windows desktop color mode. In connection with modern, powerful graphics cards the grab format can usually be set to YUV 4:2:2. This format provides 16 bits per pixel and thus reduces the PCI/PCIe bus load compared to the RGB32 format, for example.

•Internal Direct3D may sometimes become invalid after re-activating the desktop in certain situations (such as: disabling a screen saver after keyboard input, having pressed the Ctrl-Alt-Del key combination). When this happens, the overlay data is lost. The application gets signaled via the Overlay-Lost message by the FALCON driver and can redraw the overlay data (see code example below). The message is sent both to the display window and the parent window of the display window. Thus, the message can be received even when the display control itself can not process messages. However, the message has to be processed by only one of the two window handlers.

•Direct3D provides an option for stepless display scaling (see DR_ENABLE_SCALING). Please note that downscaling interlaced image data may lead to less satisfying display quality compared to images which are already captured with the desired resolution.

•Some of the FALCON SDK functions can not be used in Direct3D mode (see list below).

Parameters

Return value

The following functions can not be used together with the Direct3D mode

•is_SetVideoMode()

•is_SetColorMode()

•is_SetImageSize()

•is_UpdateDisplay()

•is_EnableDDOverlay()

•is_DisableDDOverlay()

•is_ScaleDDOverlay()

•is_ShowDDOverlay()

•is_HideDDOverlay()

•is_OvlSurfaceOffWhileMove()

•is_GetDC()

•is_ReleaseDC

•is_SetDDUpdateTime

•is_LockDDOverlayMem

•is_UnlockDDOverlayMem

•is_LockDDMem

•is_UnlockDDMem

•is_GetDDOvlSurface

•is_SetKeyColor

•is_SetKeyOffset

•is_AddToSequence

Examples

//------------------------------------

// DC-Handle

//------------------------------------

// Get DC handle for Overlay

HDC hDC;

is_DirectRenderer (h, DR_GET_OVERLAY_DC, (void*)&hDC, sizeof (hDC));

// Release DC handle

is_DirectRenderer (h, DR_RELEASE_OVERLAY_DC, NULL, NULL);

 

 

//------------------------------------

// Size of overlay

//------------------------------------

//Query maximum size of overlay area

UINT OverlaySize[2];

is_DirectRenderer (h, DR_GET_MAX_OVERLAY_SIZE,

        (void*)OverlaySize, sizeof(OverlaySize));

INT nWidth = OverlaySize[0];

INT nHeight = OverlaySize[1];

//Set size of overlay area

UINT Size[2];

Size[0] = 100;

Size[1] = 120;

is_DirectRenderer (h, DR_SET_OVERLAY_SIZE, (void*)Size, sizeof (Size));

//Set position of overlay area

UINT Position[2];

Position[0] = 20;

Position[1] = 0;

is_DirectRenderer (h, DR_SET_OVERLAY_POSITION,

        (void*)Position, sizeof (Position));

 

 

//------------------------------------

// Key color

//------------------------------------

// Get current key color

UINT OverlayKeyColor[3];

is_DirectRenderer (h, DR_GET_OVERLAY_KEY_COLOR,

        (void*)OverlayKeyColor, sizeof(OverlayKeyColor));

INT nRed   = OverlayKeyColor[0];

INT nGreen = OverlayKeyColor[1];

INT nBlue = OverlayKeyColor[2];

// Set new key color

OverlayKeyColor[0] = GetRValue(m_rgbKeyColor);

OverlayKeyColor[1] = GetGValue(m_rgbKeyColor);

OverlayKeyColor[2] = GetBValue(m_rgbKeyColor);

is_DirectRenderer (h, DR_SET_OVERLAY_KEY_COLOR,

        (void*)OverlayKeyColor, sizeof(OverlayKeyColor));

 

 

//------------------------------------

// Display

//------------------------------------

// Show overlay

is_DirectRenderer (h, DR_SHOW_OVERLAY, NULL, NULL);

// Hide overlay

is_DirectRenderer (h, DR_HIDE_OVERLAY, NULL, NULL);

 

 

//------------------------------------

// Scaling

//------------------------------------

//Enable scaling

is_DirectRenderer (h, DR_ENABLE_SCALING, NULL, NULL);

//Disable scaling

is_DirectRenderer (h, DR_DISABLE_SCALING, NULL, NULL);

 

 

//------------------------------------

// Transparenz

//------------------------------------

//Enable semi-transparent overlay

is_DirectRenderer (h, DR_ENABLE_SEMI_TRANSPARENT_OVERLAY, NULL, NULL);

//Disable semi-transparent overlay

is_DirectRenderer (h, DR_DISABLE_SEMI_TRANSPARENT_OVERLAY, NULL, NULL);

 

 

//------------------------------------

// Synchronization

//------------------------------------

//Enable auto-synchronization

is_DirectRenderer (h, DR_SET_VSYNC_AUTO, NULL, NULL);

 

//User defined synchronization: Query range and set position

UINT UserSync[2];

is_DirectRenderer (h, DR_GET_USER_SYNC_POSITION_RANGE,

        (void*)UserSync, sizeof (UserSync));

INT Min = UserSync[0];

INT Max = UserSync[1];

INT SyncPosition = 400;

is_DirectRenderer (h, DR_SET_USER_SYNC,

        (void*)&SyncPosition, sizeof (SyncPosition));

//Disable synchronization

is_DirectRenderer (h, DR_SET_VSYNC_OFF, NULL, NULL);

 

 

//------------------------------------

// BMP file

//------------------------------------

// Load overlay from BMP file

is_DirectRenderer (h, DR_LOAD_OVERLAY_FROM_FILE,

        (void*)”c:\test.bmp”, NULL);

 

 

//------------------------------------

// Delete overlay

//------------------------------------

// Delete overlay area

is_DirectRenderer (h, DR_CLEAR_OVERLAY, NULL, NULL);

 

 

//------------------------------------

// Steal mode

//------------------------------------

// Get and set color mode for image to be copied

INT nColorMode;

is_DirectRenderer (h, DR_GET_STEAL_FORMAT,

        (void*)&nColorMode, sizeof (nColorMode));

nColorMode = IS_CM_Y8;

is_DirectRenderer (h, DR_SET_STEAL_FORMAT,

        (void*)&nColorMode, sizeof (nColorMode));

// Copy image with function returning immediately

INT nwait = IS_WAIT;

is_DirectRenderer(h, DR_STEAL_NEXT_FRAME,

        (void*)&wait, sizeof (wait));

 

 

//------------------------------------

// Handle to window

//------------------------------------

// Set new window handle for image display

is_DirectRenderer (h, DR_SET_HWND, (void*)&hWnd, sizeof (hWnd));

 

 

//------------------------------------

// Compatibility

//------------------------------------

//Check graphics card compatibility

INT nRet = is_DirectRenderer (h, DR_CHECK_COMPATIBILITY, NULL, NULL);

if (nRet == IS_DR_DEVICE_CAPS_INSUFFICIENT )

//Graphics card does not support Direct3D

 

 

//------------------------------------

// Check color mode

//------------------------------------

INT nVgaMode;

// Read out current desktop color depth

INT nRet = is_GetColorDepth(h, NULL, &nVgaMode);

INT Modes[2];

Modes[0] = IS_SET_CM_RGB16;   // FALCON source mode (example)

Modes[1] = nVgaMode;       // Graphics card target mode

// Check source mode and target mode

nRet = is_DirectRenderer(h, DR_CHECK_COLOR_MODE_SUPPORT, Modes,

            2 * sizeof(INT));

if (nRet == IS_DR_DEVICE_CAPS_INSUFFICIENT )

//Graphics card does not support the current color space conversion

 

 

//------------------------------------

// „Overlay Lost“ message

//------------------------------------

// Example for a message handler of an MFC application

// in XX_sample.h

afx_msg LRESULT OnFalconMessage(WPARAM wParam, LPARAM lParam);

 

// in XX_sample.cpp

BEGIN_MESSAGE_MAP(...)

...

ON_MESSAGE(IS_FALCON_MESSAGE, OnFalconMessage)

END_MESSAGE_MAP()

 

LRESULT CXX_class::OnFalconMessage(WPARAM wParam, LPARAM lParam)

{

  switch(wParam)

  {

      case :

    // redraw the overlay data here

    ...

          break;

  } // end switch(wParam)

  return 0;

} // end  LRESULT CXX_class::OnFalconMessage