update docs

tencentyun · Aug 13, 2024 · e0691b2 · e0691b2
1 parent 1d7c06d
commit e0691b2
Show file tree

Hide file tree

Showing 40 changed files with 190 additions and 113 deletions.
diff --git a/docs/android-docs/1.7/allclasses-index.html b/docs/android-docs/1.7/allclasses-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>All Classes and Interfaces</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/allpackages-index.html b/docs/android-docs/1.7/allpackages-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>所有程序包</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/com/tencent/mps/tie/api/TIEPass.html b/docs/android-docs/1.7/com/tencent/mps/tie/api/TIEPass.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>TIEPass</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="declaration: package: com.tencent.mps.tie.api, class: TIEPass">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
@@ -80,6 +80,15 @@ <h1 title="类 TIEPass" class="title">类 TIEPass</h1>
 <div class="block">TIEPass is a class responsible for performing image enhance rendering on input images.
  The class creates a TIEPass object and provides methods for initialization, rendering, and
  releasing resources.
+
+ <p>
+ Note:
+ <ul>
+ <li>All methods of TIEPass must be called within the same GLThread.</li>
+ <li>The render method should not be called before the init method, and it should not be called after the deInit method.</li>
+ </ul>
+ </p>
+
  <p>Usage:</p>
  <ol>
  <li>Create a TIEPass object using the constructor.</li>
@@ -96,16 +105,16 @@ <h1 title="类 TIEPass" class="title">类 TIEPass</h1>
 
  // The code below must be executed in glThread.
  //----------------------GL Thread---------------------//
-
  // Init TIEPass
  tiePass.init(inputWidth, inputHeight);
+
  // If the type of inputTexture is TextureOES, you must transform it to Texture2D.
  int outputTextureId = tiePass.render(inputTextureId);
 
- //----------------------GL Thread---------------------//
-
  // Release resources when the TIEPass object is no longer needed.
  tiePass.deInit();
+ //----------------------GL Thread---------------------//
+
  </pre></div>
 </section>
 <section class="summary">
@@ -217,15 +226,20 @@ <h3>render</h3>
  processed image is rendered onto a texture within the TIEPass object. And the return is the texture's id.
  <br>
  <br>
- NOTE: The type of the texture corresponding to the textureId you pass in must be texture2D.
+ NOTE:
+ <ul>
+ <li>The type of the texture corresponding to the textureId you pass in must be texture2D.</li>
+ <li>The format of the input OpenGL texture must be GL_RGBA.</li>
+ <li>The format of the output textureId is also GL_RGBA.</li>
+ </ul>
  <br></div>
 <dl class="notes">
 <dt>参数:</dt>
 <dd><code>textureId</code> - The OpenGL textureId of the input image that needs to be processed for image enhance. The
- corresponding texture is a texture2D texture.</dd>
+ corresponding texture is a texture2D texture with GL_RGBA format.</dd>
 <dt>返回:</dt>
 <dd>The textureId of the texture2D after image enhance rendering, which is stored inside the TIEPass
- object. The size of the output texture is (inputWidth, inputHeight).</dd>
+ object. The format of the output texture is GL_RGBA. The size of the output texture is (inputWidth, inputHeight).</dd>
 </dl>
 </section>
 </li>
@@ -241,16 +255,21 @@ <h3>render</h3>
  processed image is rendered onto a texture within the TIEPass object. And the return is the texture's id.
  </p>
  <p>
- NOTE: The type of the texture corresponding to the textureId you pass in must be texture2D.
+ NOTE:
+ <ul>
+ <li>The type of the texture corresponding to the textureId you pass in must be texture2D.</li>
+ <li>The format of the input OpenGL texture must be GL_RGBA.</li>
+ <li>The format of the output textureId is also GL_RGBA.</li>
+ </ul>
  </p></div>
 <dl class="notes">
 <dt>参数:</dt>
 <dd><code>textureId</code> - The OpenGL textureId of the input image that needs to be processed for image enhance. The
- corresponding texture is a texture2D texture.</dd>
+ corresponding texture is a texture2D texture with GL_RGBA format.</dd>
 <dd><code>transformMatrix</code> - A float array representing the transform matrix to be applied to the input image during the rendering process. The matrix should be in column-major order and of size 16.</dd>
 <dt>返回:</dt>
 <dd>The textureId of the texture2D after image enhance rendering and applying the transform matrix, which is stored inside the TIEPass
- object. The size of the output texture is (inputWidth, inputHeight).</dd>
+ object. The format of the output texture is GL_RGBA. The size of the output texture is (inputWidth, inputHeight).</dd>
 </dl>
 </section>
 </li>

diff --git a/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRLogger.html b/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRLogger.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>TSRLogger</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="declaration: package: com.tencent.mps.tie.api, interface: TSRLogger">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRPass.TSRAlgorithmType.html b/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRPass.TSRAlgorithmType.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>TSRPass.TSRAlgorithmType</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="declaration: package: com.tencent.mps.tie.api, class: TSRPass, enum: TSRAlgorithmType">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRPass.html b/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRPass.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>TSRPass</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="declaration: package: com.tencent.mps.tie.api, class: TSRPass">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
@@ -80,6 +80,15 @@ <h1 title="类 TSRPass" class="title">类 TSRPass</h1>
 <div class="block">TSRPass is a class responsible for performing super-resolution rendering on input images.
  The class creates a TSRPass object and provides methods for initialization, rendering, and
  releasing resources.
+
+ <p>
+ Note:
+ <ul>
+ <li>All methods of TSRPass must be called within the same GLThread.</li>
+ <li>The render method should not be called before the init method, and it should not be called after the deInit method.</li>
+ </ul>
+ </p>
+
  <p>Usage:</p>
  <ol>
  <li>Create a TSRPass object using the constructor.</li>
@@ -98,13 +107,14 @@ <h1 title="类 TSRPass" class="title">类 TSRPass</h1>
  //----------------------GL Thread---------------------//
  // Init TSRPass
  tsrPass.init(inputWidth, inputHeight, srRatio);
+
  // If the type of inputTexture is TextureOES, you must transform it to Texture2D.
  int outputTextureId = tsrPass.render(inputTextureId);
 
- //----------------------GL Thread---------------------//
-
  // Release resources when the TSRPass object is no longer needed.
  tsrPass.deInit();
+ //----------------------GL Thread---------------------//
+
  </pre></div>
 </section>
 <section class="summary">
@@ -274,17 +284,22 @@ <h3>render</h3>
  <br>
  This method applies the super-resolution rendering process to the input image, improving its quality. The
  processed image is rendered onto a texture within the TSRPass object. And the return is the texture's id.
+
  <br>
- <br>
- NOTE: The type of the texture corresponding to the textureId you pass in must be texture2D.
+ NOTE:
+ <ul>
+ <li>The type of the texture corresponding to the textureId you pass in must be texture2D.</li>
+ <li>The format of the input OpenGL texture must be GL_RGBA.</li>
+ <li>The format of the output textureId is also GL_RGBA.</li>
+ </ul>
  <br></div>
 <dl class="notes">
 <dt>参数:</dt>
 <dd><code>textureId</code> - The OpenGL textureId of the input image that needs to be processed for super-resolution. The
-                  corresponding texture is a texture2D texture.</dd>
+                  corresponding texture is a texture2D texture with GL_RGBA format.</dd>
 <dt>返回:</dt>
 <dd>The textureId of the texture2D after super-resolution rendering, which is stored inside the TSRPass
- object. The size of the output texture is (inputWidth * srRatio, inputHeight * srRatio).</dd>
+ object. The format of the output texture is GL_RGBA. The size of the output texture is (inputWidth * srRatio, inputHeight * srRatio).</dd>
 </dl>
 </section>
 </li>
@@ -300,16 +315,22 @@ <h3>render</h3>
  processed image is rendered onto a texture within the TSRPass object. And the return is the texture's id.
  </p>
  <p>
- NOTE: The type of the texture corresponding to the textureId you pass in must be texture2D.
+ NOTE:
+ <ul>
+ <li>The type of the texture corresponding to the textureId you pass in must be texture2D.</li>
+ <li>The format of the input OpenGL texture must be GL_RGBA.</li>
+ <li>The format of the output textureId is also GL_RGBA.</li>
+ </ul>
+ <br>
  </p></div>
 <dl class="notes">
 <dt>参数:</dt>
 <dd><code>textureId</code> - The OpenGL textureId of the input image that needs to be processed for super-resolution. The
-                        corresponding texture is a texture2D texture.</dd>
+                        corresponding texture is a texture2D texture with GL_RGBA format.</dd>
 <dd><code>transformMatrix</code> - A float array representing the transform matrix to be applied to the input image during the rendering process. The matrix should be in column-major order and of size 16.</dd>
 <dt>返回:</dt>
 <dd>The textureId of the texture2D after super-resolution rendering and applying the transform matrix, which is stored inside the TSRPass
- object. The size of the output texture is (inputWidth * srRatio, inputHeight * srRatio).</dd>
+ object. The format of the output texture is GL_RGBA. The size of the output texture is (inputWidth * srRatio, inputHeight * srRatio).</dd>
 </dl>
 </section>
 </li>

diff --git a/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRSdk.TSRSdkLicenseStatus.html b/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRSdk.TSRSdkLicenseStatus.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>TSRSdk.TSRSdkLicenseStatus</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="declaration: package: com.tencent.mps.tie.api, class: TSRSdk, enum: TSRSdkLicenseStatus">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRSdk.TSRSdkLicenseVerifyResultCallback.html b/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRSdk.TSRSdkLicenseVerifyResultCallback.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>TSRSdk.TSRSdkLicenseVerifyResultCallback</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="declaration: package: com.tencent.mps.tie.api, class: TSRSdk, interface: TSRSdkLicenseVerifyResultCallback">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRSdk.html b/docs/android-docs/1.7/com/tencent/mps/tie/api/TSRSdk.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>TSRSdk</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="declaration: package: com.tencent.mps.tie.api, class: TSRSdk">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/com/tencent/mps/tie/api/package-summary.html b/docs/android-docs/1.7/com/tencent/mps/tie/api/package-summary.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>com.tencent.mps.tie.api</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="declaration: package: com.tencent.mps.tie.api">
 <meta name="generator" content="javadoc/PackageWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/com/tencent/mps/tie/api/package-tree.html b/docs/android-docs/1.7/com/tencent/mps/tie/api/package-tree.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>com.tencent.mps.tie.api 类分层结构</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="tree: package: com.tencent.mps.tie.api">
 <meta name="generator" content="javadoc/PackageTreeWriter">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/help-doc.html b/docs/android-docs/1.7/help-doc.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>API 帮助</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="help">
 <meta name="generator" content="javadoc/HelpWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/index-files/index-1.html b/docs/android-docs/1.7/index-files/index-1.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>A - 索引</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="index: A">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/index-files/index-10.html b/docs/android-docs/1.7/index-files/index-10.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>O - 索引</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="index: O">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/index-files/index-11.html b/docs/android-docs/1.7/index-files/index-11.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>P - 索引</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="index: P">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

diff --git a/docs/android-docs/1.7/index-files/index-12.html b/docs/android-docs/1.7/index-files/index-12.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (17) on Wed Jul 17 17:35:04 CST 2024 -->
+<!-- Generated by javadoc (17) on Tue Aug 13 17:09:19 CST 2024 -->
 <title>R - 索引</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-07-17">
+<meta name="dc.created" content="2024-08-13">
 <meta name="description" content="index: R">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">