surface_copy


Syntax:

surface_copy(destination, x, y, source);

Argument Description
destination The ID of the surface to copy the other surface to.
x The x position to copy to.
y The y position to copy to.
source The ID of surface to be copied.


Returns:

N/A


Description

This function simply takes the image from one surface and copies it onto another one at the specified local position within that surface (where the (0,0) position is the top left corner of the destination surface). If the destination surface already has information this will be overwritten by the copy, and the function does not change the source surface in any way.

NOTE: When working with surfaces there is the possibility that they can cease to exist at any time due to them being stored in texture memory. You should ALWAYS check that a surface exists using surface_exists before referencing them directly. For further information see Surfaces.


Example:

if view_current == 0
   {
   surface_copy(surf, 0, 0, temp_surf);
   }
else
   {
   draw_surface(surf, 0, 0);
   }

The above code will check the current view being drawn and if it is view[0] it copies the surface indexed in the variable "temp_surf" onto the surface indexed in the variable "surf". If the current view is anything other than view[0] the surface "surf" is drawn to the screen.