BImage Interface Reference

Inheritance diagram for BImage:

Public Member Functions
proto external void	Download (notnull BackendCallback pCallback)
	Download the image.
proto external void	SetImageTexture (int iNum, notnull ImageWidget pWidget)
	Sets texture data in your ImageWidget by calling ImageWidget.SetImageTexture.
proto external void	SetFitMethod (EBImageFitMethod eMethod)
	Set fit method to download the image with.
proto external EBImageFitMethod	GetFitMethod ()
	Returns currently set fit method.
proto external void	SetScale (int iWidth, int iHeight)
	Set scale of this image.
proto external int	GetWidth ()
	Returns width of the image.
proto external int	GetHeight ()
	Returns height of the image.
proto external bool	IsReady ()
	Whether this image is downloaded and ready to use.
Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Member Function Documentation

Download()

proto external void BImage.Download

(

notnull BackendCallback

pCallback

)

Download the image.

Scale and GUID must be set.

Note

If the requested scale or bigger is already downloaded (comparing equal aspect ratios), the downloaded scale will be used instead.

GetFitMethod()

proto external EBImageFitMethod BImage.GetFitMethod

(

)

Returns currently set fit method.

GetHeight()

proto external int BImage.GetHeight

(

)

Returns height of the image.

GetWidth()

proto external int BImage.GetWidth

(

)

Returns width of the image.

IsReady()

proto external bool BImage.IsReady

(

)

Whether this image is downloaded and ready to use.

SetFitMethod()

proto external void BImage.SetFitMethod

(

EBImageFitMethod

eMethod

)

Set fit method to download the image with.

SetImageTexture()

proto external void BImage.SetImageTexture	(	int	iNum,
		notnull ImageWidget	pWidget )

Sets texture data in your ImageWidget by calling ImageWidget.SetImageTexture.

When image of this 'iNum' is already loaded, then is replaced by new one. The image must be ready to use - BImage.IsReady

Parameters

iNum	Number of image (0...7)
pWidget	Widget to set the texture in

SetScale()

proto external void BImage.SetScale	(	int	iWidth,
		int	iHeight )

Set scale of this image.

If the new scale is already downloaded, the image is ready to use ( BImage.IsReady ) and you can update your widget by calling BImage.SetImageTexture. Otherwise BImage.Download must be called and you can update your widget after the download.

---

The documentation for this interface was generated from the following file:

• GameLib/generated/online/bimage/BImage.c