RenderWare V2.1

Previous Page Index Next Page

RwCamera *

RwGetCameraBackdropViewportRect(RwCamera *camera, RwInt32 *x,
RwInt32 *y, RwInt32 *width, RwInt32 *height);

Description

Retrieves the rectangular area of the viewport into which the camera’s backdrop raster is rendered.

Arguments

camera Pointer to the camera.

x Pointer to integer to receive the X coordinate of rectangle (in viewport space coordinates).

y Pointer to integer to receive the Y coordinate of rectangle (in viewport space coordinates).

width Pointer to integer to receive the width of the rectangle (in viewport space units).

height Pointer to integer to receive the height of the rectangle (in viewport space units).

Return Value

The argument camera if successful, and NULL otherwise.

Comments

If the backdrop viewport rectangle is larger than the backdrop raster, the raster will be tiled to fill the rectangle. If the backdrop viewport rectangle is smaller than the backdrop raster, the raster will be cropped to the rectangle.

Areas of the viewport not covered by the backdrop will be filled with the camera’s background color.

The backdrop viewport rectangle is not automatically changed when the camera’s viewport is modified. RwSetCameraBackdropViewportRect() should be used to modify the backdrop viewport rectangle appropriately when the camera’s viewport is modified.

For 16-bit applications accessing the RenderWare DLL the variables pointed to by x, y, width and height must be declared as RwInt32s and not ints.

See Also

RwGetCameraBackColor()

RwGetCameraBackdrop()

RwGetCameraBackdropOffset()

RwSetCameraBackColor()

RwSetCameraBackdrop()

RwSetCameraBackdropOffset()

RwSetCameraBackdropViewportRect()

RwSetCameraViewport()