Class ImageLoading

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll

A class containing methods providing image loading

C#
Copy
public class ImageLoading : object
Inheritance
ImageLoading

Methods

View Source

DownloadImageSynchronously(String)

Load an image synchronously from a remote resource.

Declaration
C#
Copy
public static PixelBuffer DownloadImageSynchronously(string url)
Parameters
Type Name Description
String url

The URL of the image file to load.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

DownloadImageSynchronously(String, Size2D)

Load an image synchronously from a remote resource.

Declaration
C#
Copy
public static PixelBuffer DownloadImageSynchronously(string url, Size2D size)
Parameters
Type Name Description
String url

The URL of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

DownloadImageSynchronously(String, Size2D, FittingModeType)

Load an image synchronously from a remote resource.

Declaration
C#
Copy
public static PixelBuffer DownloadImageSynchronously(string url, Size2D size, FittingModeType fittingMode)
Parameters
Type Name Description
String url

The URL of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

FittingModeType fittingMode

The method used to fit the shape of the image before loading to the shape defined by the size parameter.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

DownloadImageSynchronously(String, Size2D, FittingModeType, SamplingModeType)

Load an image synchronously from a remote resource.

Declaration
C#
Copy
public static PixelBuffer DownloadImageSynchronously(string url, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode)
Parameters
Type Name Description
String url

The URL of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

FittingModeType fittingMode

The method used to fit the shape of the image before loading to the shape defined by the size parameter.

SamplingModeType samplingMode

The filtering method used when sampling pixels from the input image while fitting it to desired size.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

DownloadImageSynchronously(String, Size2D, FittingModeType, SamplingModeType, Boolean)

Load an image synchronously from a remote resource.

Declaration
C#
Copy
public static PixelBuffer DownloadImageSynchronously(string url, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode, bool orientationCorrection)
Parameters
Type Name Description
String url

The URL of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

FittingModeType fittingMode

The method used to fit the shape of the image before loading to the shape defined by the size parameter.

SamplingModeType samplingMode

The filtering method used when sampling pixels from the input image while fitting it to desired size.

Boolean orientationCorrection

Reorient the image to respect any orientation metadata in its header.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

DownloadImageSynchronously(Uri, Size2D, FittingModeType)

Hidden API (Inhouse API). Using Uri class to provide safe service and secure API. Load an image synchronously from a remote resource.

Declaration
C#
Copy
public static PixelBuffer DownloadImageSynchronously(Uri uri, Size2D size, FittingModeType fittingMode)
Parameters
Type Name Description
Uri uri

The URI of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

FittingModeType fittingMode

The method used to fit the shape of the image before loading to the shape defined by the size parameter.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

GetClosestImageSize(String)

Determine the size of an image that LoadImageFromFile will provide when given the same image loading parameters.

Declaration
C#
Copy
public static Size2D GetClosestImageSize(string filename)
Parameters
Type Name Description
String filename

The name of the image.

Returns
Type Description
Size2D

Dimensions that image will have if it is loaded with given parameters.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

GetClosestImageSize(String, Size2D)

Determine the size of an image that LoadImageFromFile will provide when given the same image loading parameters.

Declaration
C#
Copy
public static Size2D GetClosestImageSize(string filename, Size2D size)
Parameters
Type Name Description
String filename

The name of the image.

Size2D size

The requested size for the image

Returns
Type Description
Size2D

Dimensions that image will have if it is loaded with given parameters.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

GetClosestImageSize(String, Size2D, FittingModeType)

Determine the size of an image that LoadImageFromFile will provide when given the same image loading parameters.

Declaration
C#
Copy
public static Size2D GetClosestImageSize(string filename, Size2D size, FittingModeType fittingMode)
Parameters
Type Name Description
String filename

The name of the image.

Size2D size

The requested size for the image

FittingModeType fittingMode

The method to use to map the source image to the desired dimensions.

Returns
Type Description
Size2D

Dimensions that image will have if it is loaded with given parameters.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

GetClosestImageSize(String, Size2D, FittingModeType, SamplingModeType)

Determine the size of an image that LoadImageFromFile will provide when given the same image loading parameters.

Declaration
C#
Copy
public static Size2D GetClosestImageSize(string filename, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode)
Parameters
Type Name Description
String filename

The name of the image.

Size2D size

The requested size for the image

FittingModeType fittingMode

The method to use to map the source image to the desired dimensions.

SamplingModeType samplingMode

The image filter to use if the image needs to be downsampled to the requested size.

Returns
Type Description
Size2D

Dimensions that image will have if it is loaded with given parameters.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

GetClosestImageSize(String, Size2D, FittingModeType, SamplingModeType, Boolean)

Determine the size of an image that LoadImageFromFile will provide when given the same image loading parameters.

Declaration
C#
Copy
public static Size2D GetClosestImageSize(string filename, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode, bool orientationCorrection)
Parameters
Type Name Description
String filename

The name of the image.

Size2D size

The requested size for the image.

FittingModeType fittingMode

The method to use to map the source image to the desired dimensions.

SamplingModeType samplingMode

The image filter to use if the image needs to be downsampled to the requested size.

Boolean orientationCorrection

Whether to use image metadata to rotate or flip the image, for example, from portrait to landscape.

Returns
Type Description
Size2D

Dimensions that image will have if it is loaded with given parameters.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

GetOriginalImageSize(String)

Get the size of an original image rotated according to image metadata

Declaration
C#
Copy
public static Size2D GetOriginalImageSize(string filename)
Parameters
Type Name Description
String filename

The name of the image.

Returns
Type Description
Size2D

Dimension of the original image.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

GetOriginalImageSize(String, Boolean)

Get the size of an original image rotated according to image metadata

Declaration
C#
Copy
public static Size2D GetOriginalImageSize(string filename, bool orientationCorrection)
Parameters
Type Name Description
String filename

The name of the image.

Boolean orientationCorrection

Reorient the image to respect any orientation metadata in its header.

Returns
Type Description
Size2D

Dimension of the original image.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

LoadImageFromBuffer(IO.Stream)

Load an image synchronously from Stream. Load from current position to end of stream.

Declaration
C#
Copy
public static PixelBuffer LoadImageFromBuffer(IO.Stream stream)
Parameters
Type Name Description
Tizen.System.IO.Stream stream

The Stream of the image file to load.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case loading failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

LoadImageFromBuffer(IO.Stream, Size2D)

Load an image synchronously from Stream. Load from current position to end of stream.

Declaration
C#
Copy
public static PixelBuffer LoadImageFromBuffer(IO.Stream stream, Size2D size)
Parameters
Type Name Description
Tizen.System.IO.Stream stream

The Stream of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case loading failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

LoadImageFromBuffer(IO.Stream, Size2D, FittingModeType)

Load an image synchronously from Stream. Load from current position to end of stream.

Declaration
C#
Copy
public static PixelBuffer LoadImageFromBuffer(IO.Stream stream, Size2D size, FittingModeType fittingMode)
Parameters
Type Name Description
Tizen.System.IO.Stream stream

The Stream of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

FittingModeType fittingMode

The method used to fit the shape of the image before loading to the shape defined by the size parameter.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case loading failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

LoadImageFromBuffer(IO.Stream, Size2D, FittingModeType, SamplingModeType)

Load an image synchronously from Stream. Load from current position to end of stream.

Declaration
C#
Copy
public static PixelBuffer LoadImageFromBuffer(IO.Stream stream, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode)
Parameters
Type Name Description
Tizen.System.IO.Stream stream

The Stream of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

FittingModeType fittingMode

The method used to fit the shape of the image before loading to the shape defined by the size parameter.

SamplingModeType samplingMode

The filtering method used when sampling pixels from the input image while fitting it to desired size.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case loading failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

LoadImageFromBuffer(IO.Stream, Size2D, FittingModeType, SamplingModeType, Boolean)

Load an image synchronously from Stream. Load from current position to end of stream.

Declaration
C#
Copy
public static PixelBuffer LoadImageFromBuffer(IO.Stream stream, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode, bool orientationCorrection)
Parameters
Type Name Description
Tizen.System.IO.Stream stream

The Stream of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

FittingModeType fittingMode

The method used to fit the shape of the image before loading to the shape defined by the size parameter.

SamplingModeType samplingMode

The filtering method used when sampling pixels from the input image while fitting it to desired size.

Boolean orientationCorrection

Reorient the image to respect any orientation metadata in its header.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case loading failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

LoadImageFromFile(String)

Load an image synchronously from local file.

Declaration
C#
Copy
public static PixelBuffer LoadImageFromFile(string url)
Parameters
Type Name Description
String url

The URL of the image file to load.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case loading failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

LoadImageFromFile(String, Size2D)

Load an image synchronously from local file.

Declaration
C#
Copy
public static PixelBuffer LoadImageFromFile(string url, Size2D size)
Parameters
Type Name Description
String url

The URL of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case loading failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

LoadImageFromFile(String, Size2D, FittingModeType)

Load an image synchronously from local file.

Declaration
C#
Copy
public static PixelBuffer LoadImageFromFile(string url, Size2D size, FittingModeType fittingMode)
Parameters
Type Name Description
String url

The URL of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

FittingModeType fittingMode

The method used to fit the shape of the image before loading to the shape defined by the size parameter.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case loading failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

LoadImageFromFile(String, Size2D, FittingModeType, SamplingModeType)

Load an image synchronously from local file.

Declaration
C#
Copy
public static PixelBuffer LoadImageFromFile(string url, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode)
Parameters
Type Name Description
String url

The URL of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

FittingModeType fittingMode

The method used to fit the shape of the image before loading to the shape defined by the size parameter.

SamplingModeType samplingMode

The filtering method used when sampling pixels from the input image while fitting it to desired size.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case loading failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

View Source

LoadImageFromFile(String, Size2D, FittingModeType, SamplingModeType, Boolean)

Load an image synchronously from local file.

Declaration
C#
Copy
public static PixelBuffer LoadImageFromFile(string url, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode, bool orientationCorrection)
Parameters
Type Name Description
String url

The URL of the image file to load.

Size2D size

The width and height to fit the loaded image to, 0.0 means whole image.

FittingModeType fittingMode

The method used to fit the shape of the image before loading to the shape defined by the size parameter.

SamplingModeType samplingMode

The filtering method used when sampling pixels from the input image while fitting it to desired size.

Boolean orientationCorrection

Reorient the image to respect any orientation metadata in its header.

Returns
Type Description
PixelBuffer

Handle to the loaded PixelBuffer object or an empty handle in case loading failed.

Remarks

Hidden API: Only for inhouse or developing usage. The behavior and interface can be changed anytime.

Extension Methods