Castle Game Engine

Class TImageTextureNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TImageTextureNode = class(TAbstractTexture2DNode)

Description

Texture image loaded from a file.

Hierarchy

Overview

Methods

Public constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;
Public function TextureDescription: string; override;
Public procedure LoadFromStream(const Stream: TStream; const MimeType: String; const UpdateUrl: String);
Public procedure LoadFromImage(const Image: TEncodedImage; const TakeImageOwnership: Boolean; const UpdateUrl: String);
Public procedure CreateNode; override;
Public class function ClassX3DType: string; override;
Public procedure SetUrl(const Value: array of string); overload;
Public procedure SetUrl(const Value: TCastleStringList); overload;

Properties

Public property FdUrl: TMFString read FFdUrl;
Public property FdFlipVertically: TSFBool read FFdFlipVertically;
Public property FlipVertically: Boolean read GetFlipVertically write SetFlipVertically;

Description

Methods

Public constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;
 
Public function TextureDescription: string; override;
 
Public procedure LoadFromStream(const Stream: TStream; const MimeType: String; const UpdateUrl: String);

Load image contents from a stream.

If UpdateUrl is not empty, then this also sets the FdUrl field to the indicated value (without actually loading the image from this URL). This is useful if you later may serialize this TImageTextureNode: thus URL will represent this image in the output. Note: aside from normal URLs (file, http and such protocols), you can always set this URL to a "data URI" that would encode the image contents. See CGE example tools/to-data-uri/to-data-uri.lpr for an example.

Public procedure LoadFromImage(const Image: TEncodedImage; const TakeImageOwnership: Boolean; const UpdateUrl: String);

Load image contents from a ready TEncodedImage instance.

If TakeImageOwnership = True then we take given Image reference, and the lifetime of this Image object will be further managed by this TImageTextureNode class (so you should no longer free it yourself). If TakeImageOwnership = False then we only copy Image contents (this is slower, but it means that ownership and freeing of given Image instance remains on your side).

If UpdateUrl is not empty, then this also sets the FdUrl field to the indicated value (without actually loading the image from this URL). This is useful if you later may serialize this TImageTextureNode: thus URL will represent this image in the output. Note: aside from normal URLs (file, http and such protocols), you can always set this URL to a "data URI" that would encode the image contents. See CGE example tools/to-data-uri/to-data-uri.lpr for an example.

Public procedure CreateNode; override;
 
Public class function ClassX3DType: string; override;
 
Public procedure SetUrl(const Value: array of string); overload;
 
Public procedure SetUrl(const Value: TCastleStringList); overload;
 

Properties

Public property FdUrl: TMFString read FFdUrl;

Internal wrapper for property Url. This wrapper API may change, we advise to access simpler Url instead.

Public property FdFlipVertically: TSFBool read FFdFlipVertically;

Internal wrapper for property FlipVertically. This wrapper API may change, we advise to access simpler FlipVertically instead.

Public property FlipVertically: Boolean read GetFlipVertically write SetFlipVertically;
 
Generated by PasDoc 0.16.0.