Files
PINRemoteImage/docs/html/Classes/PINProgressiveImage.html
2016-04-08 14:39:08 -07:00

252 lines
5.6 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>PINProgressiveImage Class Reference</title>
<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1333)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">
<h1 id="library-title">
<a href="../index.html">PINRemoteImage </a>
</h1>
<p id="developer-home">
<a href="../index.html">Pinterest</a>
</p>
</div>
</header>
<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
<li id="on-this-page" role="navigation">
<label>
On This Page
<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>
<select id="jump-to">
<option value="top">Jump To&#133;</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<optgroup label="Instance Methods">
<option value="//api/name/currentImageBlurred:maxProgressiveRenderSize:">- currentImageBlurred:maxProgressiveRenderSize:</option>
<option value="//api/name/data">- data</option>
</optgroup>
</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>
<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">PINProgressiveImage Class Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Inherits from</th>
<td>NSObject</td>
</tr><tr>
<th>Declared in</th>
<td>PINProgressiveImage.h</td>
</tr>
</tbody></table></div>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>An object which store the data of a downloading image and vends progressive scans *</p>
</div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<div class="task-list">
<div class="section-method">
<a name="//api/name/currentImageBlurred:maxProgressiveRenderSize:" title="currentImageBlurred:maxProgressiveRenderSize:"></a>
<h3 class="method-title"><code><a href="#//api/name/currentImageBlurred:maxProgressiveRenderSize:">&ndash;&nbsp;currentImageBlurred:maxProgressiveRenderSize:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Returns the latest image based on thresholds, returns nil if no new image is generated</p>
</div>
<div class="method-subsection method-declaration"><code>- (nullable PINImage *)currentImageBlurred:(BOOL)<em>blurred</em> maxProgressiveRenderSize:(CGSize)<em>maxProgressiveRenderSize</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>blurred</code></th>
<td><p>A boolean to indicate if the image should be blurred</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>maxProgressiveRenderSize</code></th>
<td><p>the maximum dimensions at which to apply a blur. If an image exceeds either the height
or width of this dimension, the image will <em>not</em> be blurred regardless of the blurred parameter.</p></td>
</tr>
</table>
</div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>PINImage a progressive scan of the image or nil if a new one has not been generated</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">PINProgressiveImage.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/data" title="data"></a>
<h3 class="method-title"><code><a href="#//api/name/data">&ndash;&nbsp;data</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Returns the current data for the image.</p>
</div>
<div class="method-subsection method-declaration"><code>- (nullable NSData *)data</code></div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>NSData the current data for the image</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">PINProgressiveImage.h</code></p>
</div>
</div>
</div>
</div>
</div>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright &copy; 2016 Pinterest. All rights reserved. Updated: 2016-04-08</p>
<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p>
</div>
</footer>
</div>
</div>
</article>
<script src="../js/script.js"></script>
</body>
</html>