icetPhysicalRenderSize(3)

NAME
icetPhysicalRenderSize -- set the size of images that are rendered

Synopsis

#include <IceT.h>

void icetPhysicalRenderSize( | IceTInt | width,
 | IceTInt | height );

Description

Specify the size of images that are rendered with icetPhysicalRenderSize. This is the size of image that is expected to be rendered by the draw callback (specified with icetDrawCallback). The width and height are captured in the ICET_PHYSICAL_RENDER_WIDTH and ICET_PHYSICAL_RENDER_HEIGHT state variables.

The size of images that are rendered do not have to be the same size as the tile they are rendering so long as they are not smaller in any dimension. In fact, when rendering multiple tiles it can often save time to render larger images. Nevertheless, by default the physical render size is set to the size of the tiles in icetAddTile because this is the most common use case.

When using the OpenGL rendering layer, the physical rendering size is overridden to the size of the OpenGL viewport in each call to icetGLDrawFrame.

Errors

None.

Warnings

ICET_INVALID_VALUE
     The width or height specified is smaller than that for the largest tile.

Bugs

None known.

Copyright
Copyright (C)2010 Sandia Corporation

Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains certain rights in this software.

This source code is released under the New BSD License.

See Also

icetAddTile(3)