<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="../../docs.xsl"?>

<docs type="symbol" project="SIEGE" version="0.8.2" rpath="../..">
	<file root="siege/core" name="window.h">
		<group key="Window" name="Window">
			<symbol id="12" kind="function" internal="false" cname="sgWindowSetIcon">
				<index>
					<entry key="WindowSetIcon">sgWindowSetIcon</entry>
				</index>
				<section name="Name">
					<names>
						<name>sgWindowSetIcon</name>
						<descr>Set the window's icon</descr>
					</names>
				</section>
				<section name="Synopsis">
					<code-block lang="C">void <ref local="true" path="." file="window" group="Window" name="sgWindowSetIcon" id="12">sgWindowSetIcon</ref>(SGBitmap* bmp);</code-block>
				</section>
				<section name="Parameters">
					<params>
						<name>bmp</name>
						<descr>The bitmap holding the icon</descr>
					</params>
				</section>
				<section name="Description">
					<p>
						This sets the window's icon in the operating system's window manager. The icon is usually displayed in the taskbar and in the top-left corner of the window.
					</p>
				</section>
				<section name="See Also">
					<sees>
						<see><ref local="false" path="." file="window" group="Window" name="sgWindow*Title*" id="13">sgWindow*Title*</ref></see>
					</sees>
				</section>
				<section name="TODO">
						<ul>
							<li>
								<p>
									(?) Description regarding whether `bmp` can be deleted once the icon is set.
								</p>
							</li>
							<li>
								<p>
									(?) sgWindowGetIcon
								</p>
							</li>
						</ul>
				</section>
			</symbol>
		</group>
	</file>
</docs>
