Automatic generation produced by ISE Eiffel
note description: "[ Bitmap functions in Gdi+. For more information, please see: MSDN Bitmap Functions: http://msdn.microsoft.com/en-us/library/ms533971(VS.85).aspx ]" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2013-05-20 15:15:17 -0800 (Mon, 20 May 2013) $" revision: "$Revision: 92557 $" class interface WEL_GDIP_BITMAP create make_with_size (a_width, a_height: INTEGER_32) -- Creation method. require larger_than_0: a_width > 0 larger_than_0: a_height > 0 make_formatted (a_width, a_height: INTEGER_32; a_format: INTEGER_32) -- Creation method require larger_than_0: a_width > 0 larger_than_0: a_height > 0 valid: (create {WEL_GDIP_PIXEL_FORMAT} end).is_valid_format (a_format) make_with_graphics (a_width, a_height: INTEGER_32; a_graphics: WEL_GDIP_GRAPHICS) -- Creation method. require larger_than_0: a_width > 0 larger_than_0: a_height > 0 not_void: a_graphics /= Void a_graphics_exists: a_graphics.exists make_from_icon (a_icon: WEL_ICON) -- Creation method. require a_icon_not_void: a_icon /= Void a_icon_exists: a_icon.exists make_from_bitmap (a_bitmap: WEL_BITMAP; a_palette: detachable WEL_PALETTE) -- Creation method. -- When convert from a_bitmap to Current, alpha channel data will lost. require a_bitmap_not_void: a_bitmap /= Void a_bitmap_exists: a_bitmap.exists a_palette_valid: a_palette /= Void implies a_palette.exists make_from_dib_bitmap (a_bitmap_info: WEL_BITMAP_INFO; a_bitmap_data: POINTER) -- Creation method. -- When convert from a_bitmap_info and a_bitmap_data to Current, alpha channel data will lost. require exists: a_bitmap_info /= Void and then a_bitmap_info.exists exists: a_bitmap_data /= default_pointer make_from_bitmap_with_alpha (a_bitmap: WEL_BITMAP) -- Copy raw image data from a_bitmap directly. -- a_bitmap must have alpha channel and bits order is argb. require exists: a_bitmap /= Void and then a_bitmap.exists create {WEL_GDIP_BITMAP} make_from_pointer (a_pointer: POINTER) -- Creation method -- Pointer points to an existing gdip_bitmap. require a_pointer_not_null: a_pointer /= default_pointer feature -- Access gdi_plus_handle: POINTER -- Handle to gdiplus.dll if present. -- (from WEL_GDIP_ANY) generating_type: TYPE [detachable WEL_GDIP_BITMAP] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: WEL_GDIP_BITMAP): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: WEL_GDIP_BITMAP): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: WEL_GDIP_BITMAP): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void exists: BOOLEAN -- Does the `item` exist? -- (from WEL_ANY) ensure -- from WEL_ANY Result = (item /= default_pointer) same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) shared: BOOLEAN -- Is `item` shared by another object? -- If False (by default), `item` will -- be destroyed by `destroy_item`. -- If True, `item` will not be destroyed. -- (from WEL_ANY) feature -- Status setting set_shared -- Set `shared` to True. -- (from WEL_ANY) ensure -- from WEL_ANY shared: shared set_unshared -- Set `shared` to False. -- (from WEL_ANY) ensure -- from WEL_ANY unshared: not shared feature -- Element change set_item (an_item: POINTER) -- Set `item` with an_item -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item feature -- Removal dispose -- Destroy the inner structure of Current. -- -- This function should be called by the GC when the -- object is collected or by the user if Current is -- no more usefull. -- (from WEL_ANY) feature -- Duplication copy (other: WEL_GDIP_BITMAP) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: WEL_GDIP_BITMAP) -- Effect equivalent to that of: -- `copy` (other . `deep_twin`) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: WEL_GDIP_BITMAP -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: WEL_GDIP_BITMAP) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: WEL_GDIP_BITMAP -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: WEL_GDIP_BITMAP -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable WEL_GDIP_BITMAP -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.`default` for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- C externals c_gdip_bitmap_get_pixel (a_gdiplus_handle, a_bitmap: POINTER; a_x, a_y: NATURAL_32; a_color: TYPED_POINTER [NATURAL_32]; a_result_status: TYPED_POINTER [INTEGER_32]) -- Get pixel of a_bitmap at a_x, a_y require a_gdiplus_handle_not_null: a_gdiplus_handle /= default_pointer a_bitmap_not_null: a_bitmap /= default_pointer c_gdip_bitmap_lock_bits (a_gdiplus_handle, a_bitmap: POINTER; a_gp_rect: POINTER; a_image_lock_flag: NATURAL_32; a_pixel_format: INTEGER_32; a_result_status: TYPED_POINTER [INTEGER_32]; a_bitmap_data: POINTER) -- Lock data bits of a_bitmap, Result is pointer to BitmapData. require a_gdiplus_handle_not_null: a_gdiplus_handle /= default_pointer a_bitmap_not_null: a_bitmap /= default_pointer c_gdip_bitmap_set_pixel (a_gdiplus_handle, a_bitmap: POINTER; a_x, a_y: NATURAL_32; a_color: NATURAL_32; a_result_status: TYPED_POINTER [INTEGER_32]) -- Set pixel of a_bitmap at a_x, a_y require a_gdiplus_handle_not_null: a_gdiplus_handle /= default_pointer a_bitmap_not_null: a_bitmap /= default_pointer c_gdip_bitmap_unlock_bits (a_gdiplus_handle, a_bitmap, a_locked_bitmap_data: POINTER; a_result_status: TYPED_POINTER [INTEGER_32]) -- Unlock a_locked_bitmap_data which if from a_bitmap require a_gdiplus_handle_not_null: a_gdiplus_handle /= default_pointer a_bitmap_not_null: a_bitmap /= default_pointer c_gdip_clone_bitmap_area_i (a_gdiplus_handle: POINTER; a_x, a_y, a_width, a_height: NATURAL_32; a_pixel_format: INTEGER_32; a_source_pixbuf: POINTER; a_dest_pixbuf: TYPED_POINTER [POINTER]; a_result_status: TYPED_POINTER [INTEGER_32]) -- Draw a_image on a_graphics. require a_gdiplus_handle_not_null: a_gdiplus_handle /= default_pointer c_gdip_create_bitmap_from_bitmap (a_gdiplus_handle: POINTER; a_image, a_palette: POINTER; a_result_status: TYPED_POINTER [INTEGER_32]): POINTER -- Create a bitmap object. require a_gdiplus_handle_not_null: a_gdiplus_handle /= default_pointer c_gdip_create_bitmap_from_dib_bitmap (a_gdiplus_handle: POINTER; a_bitmap_info, a_bitmap_data: POINTER; a_result_status: TYPED_POINTER [INTEGER_32]): POINTER -- Create a bitmap object. require a_gdiplus_handle_not_null: a_gdiplus_handle /= default_pointer c_gdip_create_bitmap_from_graphics (a_gdiplus_handle: POINTER; a_width, a_height: INTEGER_32; a_target_graphics: POINTER; a_result_status: TYPED_POINTER [INTEGER_32]): POINTER -- Create a bitmap object. require a_gdiplus_handle_not_null: a_gdiplus_handle /= default_pointer c_gdip_create_bitmap_from_hicon (a_gdiplus_handle: POINTER; a_hicon: POINTER; a_result_status: TYPED_POINTER [INTEGER_32]): POINTER -- Create a bitmap object. require a_gdiplus_handle_not_null: a_gdiplus_handle /= default_pointer c_gdip_create_bitmap_from_scan0 (a_gdiplus_handle: POINTER; a_width, a_height: INTEGER_32; a_pixel_format: INTEGER_32; a_result_status: TYPED_POINTER [INTEGER_32]): POINTER -- Create a bitmap object. require a_gdiplus_handle_not_null: a_gdiplus_handle /= default_pointer valid: (create {WEL_GDIP_PIXEL_FORMAT} end).is_valid_format (a_pixel_format) feature -- Command clone_rectangle_pixel_format (a_rectangle: WEL_GDIP_RECT; a_format: INTEGER_32): WEL_GDIP_BITMAP -- Close Current with option a_rectangle and a_format -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE valid: a_rectangle /= Void and then (a_rectangle.width > 0 and a_rectangle.height > 0) valid: (create {WEL_GDIP_PIXEL_FORMAT} end).is_valid_format (a_format) exists: exists ensure -- from WEL_GDIP_IMAGE not_void: Result /= Void size_correct: Result.width = a_rectangle.width and Result.height = a_rectangle.height get_pixel (a_x, a_y: NATURAL_32): NATURAL_32 -- Return ARGB pixel value at a_x, a_y. require exists: exists load_image_from_memory (a_pointer: POINTER; a_byte_counts: NATURAL_32) -- Load image from a_pointer -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE valid: a_pointer /= default_pointer load_image_from_path (a_file_name: PATH) -- Redefine load_image_from_raw_file (a_file: RAW_FILE) -- Load image from a_file -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE not_void: a_file /= Void ready_for_read: a_file.is_open_read load_image_from_stream (a_stream: WEL_COM_ISTREAM) -- Load image from a_stream -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE not_void: a_stream /= Void lock_bits (a_rect: WEL_GDIP_RECT; a_lock_bitmode_flag: NATURAL_32; a_pixel_format: INTEGER_32): WEL_GDIP_BITMAP_DATA -- Lock image data bits. require not_void: a_rect /= Void is_vaild: (create {WEL_GDIP_IMAGE_LOCK_MODE} end).is_valid (a_lock_bitmode_flag) is_valid: (create {WEL_GDIP_PIXEL_FORMAT} end).is_valid (a_pixel_format) exists: exists ensure not_void: Result /= Void new_bitmap: WEL_BITMAP -- Create a 32bits DIB prmulitplied ARGB bitmap from current data. require exists: exists save_image_to_memory: MANAGED_POINTER -- Save image data to result pointer -- (from WEL_GDIP_IMAGE) save_image_to_path (a_file_name: PATH) -- Save data to a file a_file_name. -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE not_void: a_file_name /= Void exists: exists save_image_to_path_with_encoder (a_file_name: PATH; a_format: WEL_GDIP_IMAGE_ENCODER) -- Save data to a file a_file_name with image encoder parameter -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE not_void: a_file_name /= Void not_void: a_format /= Void exists: exists save_image_to_path_with_encoder_and_parameters (a_file_name: PATH; a_format: WEL_GDIP_IMAGE_ENCODER; a_parameters: detachable WEL_GDIP_IMAGE_ENCODER_PARAMETERS) -- Save data to a file a_file_name with image encoder and parameters -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE not_void: a_file_name /= Void not_void: a_format /= Void exists: exists save_image_to_path_with_parameters (a_file_name: PATH; a_parameters: detachable WEL_GDIP_IMAGE_ENCODER_PARAMETERS) -- Save data to a file a_file_name with a_parameters options -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE not_void: a_file_name /= Void exists: exists save_image_to_raw_file (a_file: RAW_FILE) -- Write image data to a_file -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE not_void: a_file /= Void valid: a_file.is_open_write exists: exists save_image_to_stream (a_stream: WEL_COM_ISTREAM) -- Save data to a file. -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE not_void: a_stream /= Void exists: exists save_image_to_stream_with_encoder (a_stream: WEL_COM_ISTREAM; a_format: WEL_GDIP_IMAGE_ENCODER) -- Save data to a stream with image encoder parameter -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE not_void: a_stream /= Void not_void: a_format /= Void exists: exists save_image_to_stream_with_encoder_and_parameters (a_stream: WEL_COM_ISTREAM; a_format: WEL_GDIP_IMAGE_ENCODER; a_parameters: detachable WEL_GDIP_IMAGE_ENCODER_PARAMETERS) -- Save image to a_stream -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE not_void: a_stream /= Void not_void: a_format /= Void exists: exists save_image_to_stream_with_parameters (a_stream: WEL_COM_ISTREAM; a_parameters: detachable WEL_GDIP_IMAGE_ENCODER_PARAMETERS) -- Save data to a stream with a_parameters options -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE not_void: a_stream /= Void exists: exists set_pixel (a_x, a_y, argb_value: NATURAL_32) -- Set ARGB pixel value at a_x, a_y to argb_value. require exists: exists set_with_icon (a_icon: WEL_ICON) -- Creation method. require a_icon_not_void: a_icon /= Void a_icon_exists: a_icon.exists exists: exists sub_gdip_bitmap (a_x, a_y, a_width, a_height: NATURAL_32): WEL_GDIP_BITMAP -- Return a new GDI+ bitmap that represents a sub-pixmap of Current. require exists: exists unlock_bits (a_locked_data: WEL_GDIP_BITMAP_DATA) -- Unlock a_lock_data which is from Current datas. require not_void: a_locked_data /= Void exists: exists feature -- Destory destroy_item -- Redefine -- (from WEL_GDIP_IMAGE) require -- from WEL_ANY exists: exists feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void feature -- Query all_image_encoders: ARRAYED_LIST [WEL_GDIP_IMAGE_CODEC_INFO] -- All image encoders. -- (from WEL_GDIP_IMAGE) ensure -- from WEL_GDIP_IMAGE not_void: Result /= Void get_thumbnail_image (a_width, a_height: INTEGER_32): WEL_GDIP_IMAGE -- Gets a thumbnail image from this Image object -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE exists: exists height: INTEGER_32 -- Height -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE exists: exists is_gdi_plus_installed: BOOLEAN -- If gdiplus.dll can be found on user's machine? -- (from WEL_GDIP_ANY) pixel_format: INTEGER_32 -- Pixel format in memory -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE exists: exists ensure -- from WEL_GDIP_IMAGE valid: (create {WEL_GDIP_PIXEL_FORMAT} end).is_valid_format (Result) raw_format: detachable WEL_GUID -- Redefine require -- from WEL_GDIP_IMAGE exists: exists width: INTEGER_32 -- Width -- (from WEL_GDIP_IMAGE) require -- from WEL_GDIP_IMAGE exists: exists invariant -- from WEL_GDIP_ANY support: is_gdi_plus_installed -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2013, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class WEL_GDIP_BITMAP -- Generated by Eiffel Studio --
For more details: eiffel.org