openclonk/docs/sdk/script/fn/GetObjectBlitMode.xml

32 lines
1.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>GetObjectBlitMode</title>
<category>Objects</category>
<subcat>Display</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>int</type>
<name>overlay_id</name>
<desc>If specified, the blit mode of the graphics overlay is returned instead. The overlay must have been previously set using <funclink>SetGraphics</funclink>.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Returns the current blit mode of an object.</desc>
<remark>For an Overview of the possible blit modes, see <funclink>SetObjectBlitMode</funclink>().</remark>
<remark>For an example, see <funclink>SetObjectBlitMode</funclink>().</remark>
<related>
<funclink>GetClrModulation</funclink>
<funclink>SetObjectBlitMode</funclink>
</related>
</func>
<author>Sven2</author><date>2004-03</date>
</funcs>