X Tutup
Skip to content

Commit 3dee5ad

Browse files
authored
Change javadocs links to javadoc.io (#105)
1 parent 291b092 commit 3dee5ad

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+223
-223
lines changed

_data/navigation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ dev:
2525
- title: "Wiki"
2626
url: /wiki/
2727
- title: "Javadocs"
28-
url: https://libgdx.badlogicgames.com/ci/nightlies/docs/api/
28+
url: https://javadoc.io/doc/com.badlogicgames.gdx
2929
- title: "Versions"
3030
url: /dev/versions/
3131
- title: "Tools & Frameworks"

_pages/dev/-index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ If you want to explore some other (third-party) tutorials or inspect some demos/
3838
# Documentation
3939
The libGDX codebase is documented in two ways:
4040
- In our [Wiki](/wiki/)
41-
- And via [Javadocs](https://libgdx.badlogicgames.com/ci/nightlies/docs/api/)
41+
- And via [Javadocs](https://javadoc.io/doc/com.badlogicgames.gdx)
4242

4343
<br/>
4444

_pages/features.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ list2:
3838
list3:
3939
- "[Matrix, vector and quaternion](/wiki/math-utils/vectors-matrices-quaternions) classes; accelerated via native C code where possible (if you are interested in that, also note our [gdx-jnigen](/wiki/utils/jnigen) project)"
4040
- "[Bounding shapes and volumes as well as a Frustum class for picking and culling](/wiki/math-utils/circles-planes-rays-etc)"
41-
- "[Intersection and overlap testing](https://libgdx.badlogicgames.com/ci/nightlies/docs/api/com/badlogic/gdx/math/Intersector.html)"
41+
- "[Intersection and overlap testing](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/math/Intersector.html)"
4242
- "[Steering Behaviours, Formation Motion, Pathfinding, Behaviour Trees and Finite State Machines](https://github.com/libgdx/gdx-ai)"
4343
- "Common [interpolators](/wiki/math-utils/interpolation), different [spline implementations](/wiki/math-utils/path-interface-and-splines), concave polygon triangulators and more"
4444
- "2D physics: JNI wrapper for the popular [Box2D physics](/wiki/extensions/physics/box2d) (see also [Box2DLights](https://github.com/libgdx/box2dlights)). Alternatively, you can take a look at [jbump](https://github.com/implicit-invocation/jbump) for a simpler physics implementation."
@@ -64,7 +64,7 @@ list6:
6464
- "[Textures](/wiki/graphics/2d/spritebatch-textureregions-and-sprites)"
6565
- "[Framebuffer objects](/wiki/graphics/opengl-utils/frame-buffer-objects)"
6666
- "[Shaders](/wiki/graphics/opengl-utils/shaders), integrating easily with meshes"
67-
- "[Immediate mode rendering](https://libgdx.badlogicgames.com/ci/nightlies/docs/api/com/badlogic/gdx/graphics/glutils/ImmediateModeRenderer.html) emulation"
67+
- "[Immediate mode rendering](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/graphics/glutils/ImmediateModeRenderer.html) emulation"
6868
- "Simple [shape rendering](/wiki/graphics/opengl-utils/rendering-shapes)"
6969
- "Automatic software or hardware mipmap generation"
7070
- "Automatic handling of OpenGL ES context loss"

wiki/app/starter-classes-and-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public class DesktopLauncher {
8989
}
9090
```
9191

92-
First an [LwjglApplicationConfiguration](https://github.com/libgdx/libgdx/tree/master/backends/gdx-backend-lwjgl/src/com/badlogic/gdx/backends/lwjgl/LwjglApplicationConfiguration.java) is instantiated. This class lets one specify various configuration settings, such as the initial screen resolution, whether to use OpenGL ES 2.0 or 3.0 and so on. Refer to the [Javadocs](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/backends/lwjgl/LwjglApplicationConfiguration.html) of this class for more information.
92+
First an [LwjglApplicationConfiguration](https://github.com/libgdx/libgdx/tree/master/backends/gdx-backend-lwjgl/src/com/badlogic/gdx/backends/lwjgl/LwjglApplicationConfiguration.java) is instantiated. This class lets one specify various configuration settings, such as the initial screen resolution, whether to use OpenGL ES 2.0 or 3.0 and so on. Refer to the [Javadocs](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/backends/lwjgl/LwjglApplicationConfiguration.html) of this class for more information.
9393

9494
Once the configuration object is set, an `LwjglApplication` is instantiated. The `MyGdxGame()` class is the ApplicationListener implementing the game logic.
9595

@@ -127,7 +127,7 @@ public class MainActivity extends AndroidApplication {
127127
}
128128
```
129129

130-
The main entry-point method is the Activity's `onCreate()` method. Note that `MainActivity` derives from `AndroidApplication`, which itself derives from `Activity`. As in the desktop starter class, a configuration instance is created ([AndroidApplicationConfiguration](https://github.com/libgdx/libgdx/tree/master/backends/gdx-backend-android/src/com/badlogic/gdx/backends/android/AndroidApplicationConfiguration.java)). Once configured, the `AndroidApplication.initialize()` method is called, passing in the `ApplicationListener` (`MyGdxGame`) as well as the configuration. Refer to the [AndroidApplicationConfiguration Javadocs](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/backends/android/AndroidApplicationConfiguration.html) for more information on what configuration settings are available.
130+
The main entry-point method is the Activity's `onCreate()` method. Note that `MainActivity` derives from `AndroidApplication`, which itself derives from `Activity`. As in the desktop starter class, a configuration instance is created ([AndroidApplicationConfiguration](https://github.com/libgdx/libgdx/tree/master/backends/gdx-backend-android/src/com/badlogic/gdx/backends/android/AndroidApplicationConfiguration.java)). Once configured, the `AndroidApplication.initialize()` method is called, passing in the `ApplicationListener` (`MyGdxGame`) as well as the configuration. Refer to the [AndroidApplicationConfiguration Javadocs](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/backends/android/AndroidApplicationConfiguration.html) for more information on what configuration settings are available.
131131

132132
Android applications can have multiple activities. libGDX games should usually only consist of a single activity. Different screens of the game are implemented within libGDX, not as separate activities. The reason for this is that creating a new `Activity` also implies creating a new OpenGL context, which is time consuming and also means that all graphical resources have to be reloaded.
133133

wiki/app/the-life-cycle.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: The life cycle
44
A libGDX application has a well defined life-cycle, governing the states of an application, like creating, pausing and resuming, rendering and disposing the application.
55

66
## ApplicationListener
7-
An application developer hooks into these life-cycle events by implementing the [ApplicationListener](https://libgdx.badlogicgames.com/ci/nightlies/docs/api/com/badlogic/gdx/ApplicationListener.html) interface and passing an instance of that implementation to the `Application` implementation of a specific back-end (see [The Application Framework](/wiki/app/the-application-framework)). From there on, the `Application` will call the `ApplicationListener` every time an application level event occurs. A bare-bones `ApplicationListener` implementation may look like this:
7+
An application developer hooks into these life-cycle events by implementing the [ApplicationListener](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/ApplicationListener.html) interface and passing an instance of that implementation to the `Application` implementation of a specific back-end (see [The Application Framework](/wiki/app/the-application-framework)). From there on, the `Application` will call the `ApplicationListener` every time an application level event occurs. A bare-bones `ApplicationListener` implementation may look like this:
88

99
```java
1010
public class MyGame implements ApplicationListener {
@@ -28,7 +28,7 @@ public class MyGame implements ApplicationListener {
2828
}
2929
```
3030

31-
One can also derive from the [ApplicationAdapter](https://libgdx.badlogicgames.com/ci/nightlies/docs/api/com/badlogic/gdx/ApplicationAdapter.html) class, which provides empty default implementations for those methods.
31+
One can also derive from the [ApplicationAdapter](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/ApplicationAdapter.html) class, which provides empty default implementations for those methods.
3232

3333
Once passed to the `Application`, the `ApplicationListener` methods will be called as follows:
3434

wiki/articles/getting-help.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ The [libGDX community](https://libgdx.com/community/) is glad to help you when y
2626

2727
Please go through this short checklist to be sure you haven't missed an easy to find solution.
2828

29-
* Are you using the latest [nightly build](https://libgdx.badlogicgames.com/download.html)? Please try that first, as issues are being fixed every single day.
30-
* Have you read the documentation on the [Table of Contents](/wiki/index)? It can also be very helpful to look at the [Javadocs](https://libgdx.badlogicgames.com/nightlies/docs/api/) and [source code](https://github.com/libgdx/libgdx) (don't be shy!). Search the [tests](https://github.com/libgdx/libgdx/tree/master/tests/gdx-tests/src/com/badlogic/gdx/tests) for a specific class to find example code.
29+
* Are you using the latest nightly build? You can do so by changing `gdxVersion` in `build.gradle` to the snapshot version listed [on GitHub](https://github.com/libgdx/libgdx#readme). Please try that first, as issues are being fixed every single day.
30+
* Have you read the documentation on the [Table of Contents](/wiki/index)? It can also be very helpful to look at the [Javadocs](https://javadoc.io/doc/com.badlogicgames.gdx) and [source code](https://github.com/libgdx/libgdx) (don't be shy!). Search the [tests](https://github.com/libgdx/libgdx/tree/master/tests/gdx-tests/src/com/badlogic/gdx/tests) for a specific class to find example code.
3131
* Have you [searched on our Discord server](https://libgdx.com/community/discord/) for your problem?
3232
* Have you [searched the issue tracker](https://github.com/libgdx/libgdx/issues?q=is%3Aissue) for your problem? Be sure to search "All issues", not just "Open issues".
3333

wiki/articles/memory-management.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: Memory management
33
---
44
Games are resource heavy applications. Images and sound effects can take up a considerable amount of RAM. Also, most of these resources are not managed by the Java garbage collector. Instead they are managed by native drivers. Having the garbage collector decide when to release a 5 megabyte texture from video ram wouldn't be a too bright idea either.
55

6-
We want fine grained control over the life-time of our resources. There are multiple classes in libGDX which represent such resources. They all implement a common [Disposable](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/utils/Disposable.html) interface which indicates that instances of this class need to be disposed of manually at the end of the life-time. **Failure to dispose resources will lead to severe memory leaks!**
6+
We want fine grained control over the life-time of our resources. There are multiple classes in libGDX which represent such resources. They all implement a common [Disposable](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/utils/Disposable.html) interface which indicates that instances of this class need to be disposed of manually at the end of the life-time. **Failure to dispose resources will lead to severe memory leaks!**
77

8-
The following classes need to be disposed of manually (might not be complete, [click here](https://libgdx.badlogicgames.com/ci/nightlies/docs/api/com/badlogic/gdx/utils/Disposable.html) instead for the full list):
8+
The following classes need to be disposed of manually (might not be complete, [click here](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/utils/Disposable.html) instead for the full list):
99

1010
* AssetManager
1111
* Bitmap
@@ -50,9 +50,9 @@ This is vital for memory management in games that have frequent object spawning,
5050

5151
libGDX offers a couple tools for easy pooling.
5252

53-
* [Poolable](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/utils/Pool.Poolable.html) interface
54-
* [Pool](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/utils/Pool.html)
55-
* [Pools](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/utils/Pools.html)
53+
* [Poolable](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/utils/Pool.Poolable.html) interface
54+
* [Pool](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/utils/Pool.html)
55+
* [Pools](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/utils/Pools.html)
5656

5757
Implementing the `Poolable` interface means you will have a `reset()` method in your object, which will be automatically called when you free the object.
5858

@@ -140,14 +140,14 @@ public class World {
140140
}
141141
```
142142

143-
The [Pools](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/utils/Pools.html) class provides static methods for dynamically creating pools of any objects (using [ReflectionPool](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/utils/ReflectionPool.html) and black magic). In the above example, it could be used like this.
143+
The [Pools](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/utils/Pools.html) class provides static methods for dynamically creating pools of any objects (using [ReflectionPool](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/utils/ReflectionPool.html) and black magic). In the above example, it could be used like this.
144144
```java
145145
private final Pool<Bullet> bulletPool = Pools.get(Bullet.class);
146146
```
147147

148148
### How to Use Pool
149149

150-
A `Pool<>` manages a single type of object, so it is parameterized by that type. Objects are taken from a specific `Pool` instance by invoking `obtain` and then should be returned to the Pool by invoking `free`. The objects in the pool may optionally implement the [`Pool.Poolable`](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/utils/Pool.Poolable.html) interface (which just requires a `reset()` method be present), in which case the `Pool` will automatically reset the objects when they are returned to the pool. By default, objects are initially allocated on demand (so if you never invoke `obtain`, the Pool will contain no objects). It is possible to force the `Pool` to allocate a number of objects by calling `fill()` after instantiation. Initial allocation is useful to have control over when these first time allocations occur.
150+
A `Pool<>` manages a single type of object, so it is parameterized by that type. Objects are taken from a specific `Pool` instance by invoking `obtain` and then should be returned to the Pool by invoking `free`. The objects in the pool may optionally implement the [`Pool.Poolable`](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/utils/Pool.Poolable.html) interface (which just requires a `reset()` method be present), in which case the `Pool` will automatically reset the objects when they are returned to the pool. By default, objects are initially allocated on demand (so if you never invoke `obtain`, the Pool will contain no objects). It is possible to force the `Pool` to allocate a number of objects by calling `fill()` after instantiation. Initial allocation is useful to have control over when these first time allocations occur.
151151

152152
You must implement your own subclass of `Pool<>` because the `newObject` method is abstract.
153153

wiki/audio/audio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Audio
55

66
libGDX provides methods to playback small sound effects as well as stream larger music pieces directly from disk. It also provides convenient read and write access to the audio hardware.
77

8-
All access to the audio facilities is done through the [audio module](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/Audio.html), referenced by:
8+
All access to the audio facilities is done through the [audio module](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/Audio.html), referenced by:
99

1010
```java
1111
Audio audio = Gdx.audio;

wiki/audio/playing-pcm-audio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Playing PCM audio
33
---
44
The audio module can provide you direct access to the audio hardware for writing [PCM samples](https://en.wikipedia.org/wiki/Pulse-code_modulation) to it.
55

6-
The audio hardware is abstracted via the [AudioDevice](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/audio/AudioDevice.html) [(source)](https://github.com/libgdx/libgdx/blob/master/gdx/src/com/badlogic/gdx/audio/AudioDevice.java) interface.
6+
The audio hardware is abstracted via the [AudioDevice](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/audio/AudioDevice.html) [(source)](https://github.com/libgdx/libgdx/blob/master/gdx/src/com/badlogic/gdx/audio/AudioDevice.java) interface.
77

88
To create a new `AudioDevice` instance we do the following:
99

wiki/audio/recording-pcm-audio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Recording PCM audio
33
---
4-
You can access PCM data from the microphone on a PC or Android phone via the [AudioRecorder](https://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/audio/AudioRecorder.html) [(code)](https://github.com/libgdx/libgdx/blob/master/gdx/src/com/badlogic/gdx/audio/AudioRecorder.java) interface. To create an instance of that interface use:
4+
You can access PCM data from the microphone on a PC or Android phone via the [AudioRecorder](https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/audio/AudioRecorder.html) [(code)](https://github.com/libgdx/libgdx/blob/master/gdx/src/com/badlogic/gdx/audio/AudioRecorder.java) interface. To create an instance of that interface use:
55

66
```java
77
AudioRecorder recorder = Gdx.audio.newAudioRecorder(22050, true);

0 commit comments

Comments
 (0)
X Tutup