com.wikitude

Class NativeStartupConfiguration

java.lang.Object

com.wikitude.common.startup.StartupConfiguration

com.wikitude.NativeStartupConfiguration

public class NativeStartupConfiguration
extends StartupConfiguration

Configuration object class for the Wikitude Native SDK.
This class encapsulates information needed for internal initialization of the Wikitude SDK so changing values after it has been passed to the engine will have no effect.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ORIGIN_DEFAULT
static String	ORIGIN_UNITY

Fields inherited from class com.wikitude.common.startup.StartupConfiguration

mOrigin

Constructor Summary

Constructors

Constructor and Description
NativeStartupConfiguration()

Method Summary

Modifier and Type	Method and Description
String	getDefaultOrigin()
List<RenderSettings.RenderingAPI>	getRenderingAPI() Get which RenderingAPIs are used by the Wikitude SDK.
int	getTextureId()
boolean	isCameraRunningOnStartupEnsured()
boolean	isValidOrigin()
void	setEnsureRunningCameraOnStartup(boolean ensureRunningCameraOnStartup)
void	setRenderingAPI(RenderSettings.RenderingAPI... renderingAPIs) Sets the RenderingAPIs the Wikitude SDK should use.
void	setTextureId(int textureId)

Methods inherited from class com.wikitude.common.startup.StartupConfiguration

getCameraFocusMode, getCameraManualFocusDistance, getCameraPosition, getCameraResolution, getKey, getLicenseKey, getOrigin, isCamera2Enabled, setCamera2Enabled, setCameraFocusMode, setCameraManualFocusDistance, setCameraPosition, setCameraResolution, setLicenseKey, setOrigin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ORIGIN_UNITY

public static final String ORIGIN_UNITY

See Also:

Constant Field Values

ORIGIN_DEFAULT

public static final String ORIGIN_DEFAULT

See Also:

Constant Field Values

Constructor Detail

NativeStartupConfiguration

public NativeStartupConfiguration()

Method Detail

getRenderingAPI

public List<RenderSettings.RenderingAPI> getRenderingAPI()

Get which RenderingAPIs are used by the Wikitude SDK.

Returns:

List containing the possible RenderingAPIs.

See Also:

RenderSettings.RenderingAPI

setRenderingAPI

public void setRenderingAPI(RenderSettings.RenderingAPI... renderingAPIs)

Sets the RenderingAPIs the Wikitude SDK should use.

Internal Rendering:
The SDK will try to create a GL context with the highest specified version and supported version.
If no RenderSettings.RenderingAPI is specified the Wikitude SDK will use OpenGL ES 2 internally.
e.g.:

 
      NativeStartupConfiguration startupConfig = new NativeStartupConfiguration();

      // try to create OpenGL ES 3 context, if OpenGL ES 3 is not supported on the device create an OpenGL ES 2 context
      startupConfig.setRenderingAPI(RenderSettings.RenderingAPI.OPENGL_ES_3,
                                          RenderSettings.RenderingAPI.OPENGL_ES_2);

      // try to create OpenGL ES 3 context, if OpenGL ES 3 is not supported on the device there will be undefined behaviour
      startupConfig.setRenderingAPI(RenderSettings.RenderingAPI.OPENGL_ES_3);

      // try to create OpenGL ES 2 context
      startupConfig.setRenderingAPI();
 
 

External Rendering
The SDK will expect and use the specified RenderingAPI internally. If this is not set the SDK expects OpenGL ES 2.0. Only one or none may be set, otherwise an IllegalArgumentException will be thrown once the SDK starts.

Parameters:

renderingAPIs - Varargs specifying the possible RenderingAPIs

See Also:

RenderSettings.RenderingAPI

setEnsureRunningCameraOnStartup

public void setEnsureRunningCameraOnStartup(boolean ensureRunningCameraOnStartup)

isCameraRunningOnStartupEnsured

public boolean isCameraRunningOnStartupEnsured()

getTextureId

public int getTextureId()

setTextureId

public void setTextureId(int textureId)

isValidOrigin

public boolean isValidOrigin()

Specified by:

isValidOrigin in class StartupConfiguration

getDefaultOrigin

public String getDefaultOrigin()

Specified by:

getDefaultOrigin in class StartupConfiguration