87 lines
4.1 KiB
HTML
87 lines
4.1 KiB
HTML
<!-- This page was created with the RAD auto-doc generator. -->
|
|
<!doctype html public "-//w3c//dtd html 3.2 final//en">
|
|
<html>
|
|
<head>
|
|
<title>BINK</title>
|
|
<meta http-equiv="content-type" content="text/html; charset=iso8859-1">
|
|
<meta name="ms.locale" content="en-us">
|
|
<meta name="description" content="is a structure returned from BinkOpen.">
|
|
<meta name="ms-hkwd" content="BINK">
|
|
<link rel="stylesheet" title="default" href="reference.css" type="text/css" media="screen">
|
|
</head>
|
|
<body topmargin="0">
|
|
<table cellspacing=0 cellpadding=0 class=bar width=100% height=25>
|
|
<tr class=bar>
|
|
<td class=bar>
|
|
<i> <a href="index.html" class=trn>Bink SDK 1.5v</a></i>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h1>BINK</h1>
|
|
<p>The structure <b>BINK</b> is a structure returned from BinkOpen.</p>
|
|
<table width=100% cellspacing=0 class=pre>
|
|
<tr class=pre>
|
|
<td class=pre>
|
|
<pre><b>struct <a href="BINK.html" class=trn>BINK</a>
|
|
{
|
|
  <a href="U32.html" class=trn>U32</a></b><i> Width</i><b>;
|
|
  <a href="U32.html" class=trn>U32</a></b><i> Height</i><b>;
|
|
  <a href="U32.html" class=trn>U32</a></b><i> Frames</i><b>;
|
|
  <a href="U32.html" class=trn>U32</a></b><i> FrameNum</i><b>;
|
|
  <a href="U32.html" class=trn>U32</a></b><i> FrameRate</i><b>;
|
|
  <a href="U32.html" class=trn>U32</a></b><i> FrameRateDiv</i><b>;
|
|
  <a href="U32.html" class=trn>U32</a></b><i> ReadError</i><b>;
|
|
  <a href="BINK_OPEN_FLAGS.html" class=trn>BINK_OPEN_FLAGS</a></b><i> OpenFlags</i><b>;
|
|
  <a href="BINKRECT_ARRAY.html" class=trn>BINKRECT_ARRAY</a></b><i> FrameRects</i><b>;
|
|
  <a href="U32.html" class=trn>U32</a></b><i> NumRects</i><b>;
|
|
  <a href="U32.html" class=trn>U32</a></b><i> NumTracks</i><b>;
|
|
};</b></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h4>Out Members</h4>
|
|
<dl>
|
|
<dt><i>Width</i></dt>
|
|
<dd>Specifies the width of the Bink file.</dd>
|
|
<dt><i>Height</i></dt>
|
|
<dd>Specifies the height of the Bink file.</dd>
|
|
<dt><i>Frames</i></dt>
|
|
<dd>Specifies the number of frames in the Bink file.</dd>
|
|
<dt><i>FrameNum</i></dt>
|
|
<dd>Specifies the frame to be displayed of the Bink file.</dd>
|
|
<dt><i>FrameRate</i></dt>
|
|
<dd>Along with FrameRateDiv, specifies the frame rate of the Bink file. The frame rate is calculated by (bink->FrameRate/bink->FrameRateDiv). So, for example, at 15 fps, FrameRate would be 15 and FrameRateDiv would be 1.</dd>
|
|
<dt><i>FrameRateDiv</i></dt>
|
|
<dd>Specifies the frame rate divisor of the Bink file.</dd>
|
|
<dt><i>ReadError</i></dt>
|
|
<dd>set to non-zero if an IO error has occurred during playback.</dd>
|
|
<dt><i>OpenFlags</i></dt>
|
|
<dd>Specifies the flags currently being used by the open Bink file.</dd>
|
|
<dt><i>FrameRects</i></dt>
|
|
<dd>Returns the dirty rectangles from the last call to <a href="BinkGetRects.html">BinkGetRects</a>.</dd>
|
|
<dt><i>NumRects</i></dt>
|
|
<dd>Returns the number of dirty rectangles from the last call to <a href="BinkGetRects.html">BinkGetRects</a>.</dd>
|
|
<dt><i>NumTracks</i></dt>
|
|
<dd>Returns the number of audio tracks in the Bink file.</dd>
|
|
</dl>
|
|
<h4>Discussion</h4>
|
|
<p>The BINK structure is pointed to by the HBINK handle that is returned from <a href="BinkOpen.html">BinkOpen</a>. You can dereference the pointer to access any of these information fields. Note that you should <b>never</b> change any of these values!</p>
|
|
<p>
|
|
<br>
|
|
<b>Group:</b>
|
|
<a href="Bink API.html">Bink API</a><br>
|
|
<b>Related Sections:</b>
|
|
<a href="Audio Tracks in Bink.html">Audio Tracks in Bink</a>, <a href="Critical File I-O haq3ylyt.html">Critical File I/O handling in Bink</a><br>
|
|
<b>Related Functions:</b>
|
|
<a href="BinkGetRects.html">BinkGetRects</a>, <a href="BinkGetTrackID.html">BinkGetTrackID</a>, <a href="BinkMacOpen.html">BinkMacOpen</a>, <a href="BinkOpen.html">BinkOpen</a>, <a href="BinkOpenTrack.html">BinkOpenTrack</a><br>
|
|
<b>Related Basic Types:</b>
|
|
<a href="BINKRECT_ARRAY.html">BINKRECT_ARRAY</a>, <a href="BINK_OPEN_FLAGS.html">BINK_OPEN_FLAGS</a>, <a href="HBINK.html">HBINK</a>, <a href="U32.html">U32</a></p>
|
|
<p align=center>
|
|
<a href="mailto:Bink1@radgametools.com">For technical support, e-mail Bink1@radgametools.com</a>
|
|
<br>
|
|
<a href="http://www.radgametools.com/bnkmain.htm?from=help1.5v">© Copyright 1994-2003 RAD Game Tools, Inc. All Rights Reserved.</a>
|
|
</p>
|
|
<br>
|
|
</body>
|
|
</html>
|