![]() |
![]() |
![]() |
Entangle Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
struct EntanglePreferences; struct EntanglePreferencesClass; EntanglePreferences * entangle_preferences_new (void
); gboolean entangle_preferences_interface_get_auto_connect (EntanglePreferences *prefs
); void entangle_preferences_interface_set_auto_connect (EntanglePreferences *prefs
,gboolean autoconn
); gboolean entangle_preferences_interface_get_screen_blank (EntanglePreferences *prefs
); void entangle_preferences_interface_set_screen_blank (EntanglePreferences *prefs
,gboolean blank
); gchar ** entangle_preferences_interface_get_plugins (EntanglePreferences *prefs
); void entangle_preferences_interface_add_plugin (EntanglePreferences *prefs
,const char *name
); void entangle_preferences_interface_remove_plugin (EntanglePreferences *prefs
,const char *name
); gboolean entangle_preferences_interface_get_histogram_linear (EntanglePreferences *prefs
); void entangle_preferences_interface_set_histogram_linear (EntanglePreferences *prefs
,gboolean enabled
); char * entangle_preferences_capture_get_last_session (EntanglePreferences *prefs
); void entangle_preferences_capture_set_last_session (EntanglePreferences *prefs
,const gchar *dir
); char * entangle_preferences_capture_get_filename_pattern (EntanglePreferences *prefs
); void entangle_preferences_capture_set_filename_pattern (EntanglePreferences *prefs
,const gchar *pattern
); gboolean entangle_preferences_capture_get_continuous_preview (EntanglePreferences *prefs
); void entangle_preferences_capture_set_continuous_preview (EntanglePreferences *prefs
,gboolean enabled
); gboolean entangle_preferences_capture_get_delete_file (EntanglePreferences *prefs
); void entangle_preferences_capture_set_delete_file (EntanglePreferences *prefs
,gboolean enabled
); gboolean entangle_preferences_capture_get_sync_clock (EntanglePreferences *prefs
); void entangle_preferences_capture_set_sync_clock (EntanglePreferences *prefs
,gboolean enabled
); gboolean entangle_preferences_cms_get_enabled (EntanglePreferences *prefs
); void entangle_preferences_cms_set_enabled (EntanglePreferences *prefs
,gboolean enabled
); EntangleColourProfile * entangle_preferences_cms_get_rgb_profile (EntanglePreferences *prefs
); void entangle_preferences_cms_set_rgb_profile (EntanglePreferences *prefs
,EntangleColourProfile *prof
); EntangleColourProfile * entangle_preferences_cms_get_monitor_profile (EntanglePreferences *prefs
); void entangle_preferences_cms_set_monitor_profile (EntanglePreferences *prefs
,EntangleColourProfile *prof
); gboolean entangle_preferences_cms_get_detect_system_profile (EntanglePreferences *prefs
); void entangle_preferences_cms_set_detect_system_profile (EntanglePreferences *prefs
,gboolean enabled
); EntangleColourProfileIntent entangle_preferences_cms_get_rendering_intent (EntanglePreferences *prefs
); void entangle_preferences_cms_set_rendering_intent (EntanglePreferences *prefs
,EntangleColourProfileIntent intent
); gchar * entangle_preferences_img_get_aspect_ratio (EntanglePreferences *prefs
); void entangle_preferences_img_set_aspect_ratio (EntanglePreferences *prefs
,const gchar *aspect
); gint entangle_preferences_img_get_mask_opacity (EntanglePreferences *prefs
); void entangle_preferences_img_set_mask_opacity (EntanglePreferences *prefs
,gint opacity
); gboolean entangle_preferences_img_get_mask_enabled (EntanglePreferences *prefs
); void entangle_preferences_img_set_mask_enabled (EntanglePreferences *prefs
,gboolean enabled
); gboolean entangle_preferences_img_get_focus_point (EntanglePreferences *prefs
); void entangle_preferences_img_set_focus_point (EntanglePreferences *prefs
,gboolean enabled
); gint entangle_preferences_img_get_grid_lines (EntanglePreferences *prefs
); void entangle_preferences_img_set_grid_lines (EntanglePreferences *prefs
,gint gridLines
); gboolean entangle_preferences_img_get_embedded_preview (EntanglePreferences *prefs
); void entangle_preferences_img_set_embedded_preview (EntanglePreferences *prefs
,gboolean enabled
); gboolean entangle_preferences_img_get_onion_skin (EntanglePreferences *prefs
); void entangle_preferences_img_set_onion_skin (EntanglePreferences *prefs
,gboolean enabled
); gint entangle_preferences_img_get_onion_layers (EntanglePreferences *prefs
); void entangle_preferences_img_set_onion_layers (EntanglePreferences *prefs
,gint layers
); gchar * entangle_preferences_img_get_background (EntanglePreferences *prefs
); void entangle_preferences_img_set_background (EntanglePreferences *prefs
,const gchar *bkg
); gchar * entangle_preferences_img_get_highlight (EntanglePreferences *prefs
); void entangle_preferences_img_set_highlight (EntanglePreferences *prefs
,const gchar *bkg
);
"capture-continuous-preview" gboolean : Read / Write "capture-delete-file" gboolean : Read / Write "capture-filename-pattern" gchar* : Read / Write "capture-last-session" gchar* : Read / Write "capture-sync-clock" gboolean : Read / Write "cms-detect-system-profile" gboolean : Read / Write "cms-enabled" gboolean : Read / Write "cms-monitor-profile" EntangleColourProfile* : Read / Write "cms-rendering-intent" EntangleColourProfileIntent : Read / Write "cms-rgb-profile" EntangleColourProfile* : Read / Write "img-aspect-ratio" gchar* : Read / Write "img-background" gchar* : Read / Write "img-embedded-preview" gboolean : Read / Write "img-focus-point" gboolean : Read / Write "img-grid-lines" gint : Read / Write "img-highlight" gchar* : Read / Write "img-mask-enabled" gboolean : Read / Write "img-mask-opacity" gint : Read / Write "img-onion-layers" gint : Read / Write "img-onion-skin" gboolean : Read / Write "interface-auto-connect" gboolean : Read / Write "interface-histogram-linear" gboolean : Read / Write "interface-screen-blank" gboolean : Read / Write
gboolean entangle_preferences_interface_get_auto_connect
(EntanglePreferences *prefs
);
Determine whether the application will attempt to automatically connect to cameras at startup
|
the preferences store. [transfer none] |
Returns : |
TRUE if cameras will be automatically connected, FALSE otherwise |
void entangle_preferences_interface_set_auto_connect (EntanglePreferences *prefs
,gboolean autoconn
);
gboolean entangle_preferences_interface_get_screen_blank
(EntanglePreferences *prefs
);
Determine if the screen wil be blanked prior to capturing the image
|
the preferences store. [transfer none] |
Returns : |
TRUE if the screen will blank at time of capture |
void entangle_preferences_interface_set_screen_blank (EntanglePreferences *prefs
,gboolean blank
);
If blank
is set to TRUE, the screen will be blanked
during capture to avoid light from the screen influencing
the scene being shot.
|
the preferences store. [transfer none] |
|
TRUE to make the screen blank during capture |
gchar ** entangle_preferences_interface_get_plugins
(EntanglePreferences *prefs
);
Get the names of the plugins that are enabled for the application
|
the preferences store. [transfer none] |
Returns : |
the list of plugin names, NULL terminated. [transfer full][array zero-terminated=1] |
void entangle_preferences_interface_add_plugin (EntanglePreferences *prefs
,const char *name
);
Add the plugin called name
to the active list
|
the preferences store. [transfer none] |
|
the plugin to add. [transfer none] |
void entangle_preferences_interface_remove_plugin (EntanglePreferences *prefs
,const char *name
);
Remove the plugin called name
from the active list
|
the preferences store. [transfer none] |
|
the plugin to remove. [transfer none] |
gboolean entangle_preferences_interface_get_histogram_linear
(EntanglePreferences *prefs
);
Determine if the histogram will be displayed in linear or logarithmic mode
|
the preferences store. [transfer none] |
Returns : |
TRUE if the histogram is linear, FALSE for logarithmic |
void entangle_preferences_interface_set_histogram_linear (EntanglePreferences *prefs
,gboolean enabled
);
If enabled
is TRUE then the histogram will be displayed in
linear mode, otherwise logarithmic mode will be used
|
the preferences store. [transfer none] |
|
TRUE to set the histogram to linear mode |
char * entangle_preferences_capture_get_last_session
(EntanglePreferences *prefs
);
Get the most recently used directory for the image session
|
the preferences store. [transfer none] |
Returns : |
the session directory. [transfer full] |
void entangle_preferences_capture_set_last_session (EntanglePreferences *prefs
,const gchar *dir
);
Record dir
as being the most recently used session
directory
|
the preferences store. [transfer none] |
|
the new session. [transfer none] |
char * entangle_preferences_capture_get_filename_pattern
(EntanglePreferences *prefs
);
Get the filename pattern to use for naming images that are saved after download. In the pattern any repeated sequence of 'X' characters will be replaced with the image sequence number
|
the preferences store. [transfer none] |
Returns : |
the filename pattern. [transfer full] |
void entangle_preferences_capture_set_filename_pattern (EntanglePreferences *prefs
,const gchar *pattern
);
Set the pattern to use for naming images that are saved after download.
|
the preferences store. [transfer none] |
|
the filename pattern. [transfer none] |
gboolean entangle_preferences_capture_get_continuous_preview
(EntanglePreferences *prefs
);
Determine if the preview mode will continue to operate after each image is captured.
|
the preferences store. [transfer none] |
Returns : |
TRUE if preview mode will continue after capture, FALSE otherwise |
void entangle_preferences_capture_set_continuous_preview (EntanglePreferences *prefs
,gboolean enabled
);
If enabled
is set to TRUE, then the preview mode will
continue to run after each image is captured
|
the preferences store. [transfer none] |
|
TRUE to make preview mode continue after capture |
gboolean entangle_preferences_capture_get_delete_file
(EntanglePreferences *prefs
);
Determine if the file will be deleted from the camera after it has been downloaded.
|
the preferences store. [transfer none] |
Returns : |
TRUE if the files will be deleted after download |
void entangle_preferences_capture_set_delete_file (EntanglePreferences *prefs
,gboolean enabled
);
If enabled
is set to TRUE, then files will be deleted from the
camera after they are downloaded.
|
the preferences store. [transfer none] |
|
TRUE if files should be deleted from camera after capture |
gboolean entangle_preferences_capture_get_sync_clock
(EntanglePreferences *prefs
);
Determines if the camera clock will be automatically synchronized to the host computer clock when first connecting
|
the preferences store. [transfer none] |
Returns : |
TRUE if the clock will synchronized, FALSE otherwise |
void entangle_preferences_capture_set_sync_clock (EntanglePreferences *prefs
,gboolean enabled
);
If enabled
is TRUE, then the camera clock will be synchronized to
the host computer clock when first connecting
|
the preferences store. [transfer none] |
|
TRUE if the clock should be synchronized |
gboolean entangle_preferences_cms_get_enabled
(EntanglePreferences *prefs
);
Determine if images should be displayed with colour management applied
|
the preferences store. [transfer none] |
Returns : |
TRUE if colour management is active |
void entangle_preferences_cms_set_enabled (EntanglePreferences *prefs
,gboolean enabled
);
If enabled
is TRUE, colour management will be applied when
displaying images
|
the preferences store. [transfer none] |
|
TRUE to enable colour management |
EntangleColourProfile * entangle_preferences_cms_get_rgb_profile
(EntanglePreferences *prefs
);
Get the colour profile that represents the RGB working space
|
the preferences store. [transfer none] |
Returns : |
the colour space. [transfer full] |
void entangle_preferences_cms_set_rgb_profile (EntanglePreferences *prefs
,EntangleColourProfile *prof
);
Set the colour profile that represents the RGB working space
|
the preferences store. [transfer none] |
|
the new rgb profile. [transfer none][allow-none] |
EntangleColourProfile * entangle_preferences_cms_get_monitor_profile
(EntanglePreferences *prefs
);
Get the profile associated with the display, if any.
|
the preferences store. [transfer none] |
Returns : |
the colour profile. [transfer full] |
void entangle_preferences_cms_set_monitor_profile (EntanglePreferences *prefs
,EntangleColourProfile *prof
);
If prof
is not NULL, it will be used as the current monitor
profile. This is only honoured if automatic detection of
the monitor profile is disabled.
|
the preferences store. [transfer none] |
|
the new monitor profile. [transfer none][allow-none] |
gboolean entangle_preferences_cms_get_detect_system_profile
(EntanglePreferences *prefs
);
Determine if the monitor profile will be automatically detected, which is usually preferrable since it copes with multiple monitor scenarios
|
the preferences store. [transfer none] |
void entangle_preferences_cms_set_detect_system_profile (EntanglePreferences *prefs
,gboolean enabled
);
If enabled
is TRUE then the monitor profile will be
automatically detected
|
the preferences store. [transfer none] |
|
TRUE to automatically detect the monitor profile |
EntangleColourProfileIntent entangle_preferences_cms_get_rendering_intent
(EntanglePreferences *prefs
);
Determine the rendering intent for displaying images
|
the preferences store. [transfer none] |
Returns : |
the image rendering intent |
void entangle_preferences_cms_set_rendering_intent (EntanglePreferences *prefs
,EntangleColourProfileIntent intent
);
Set the rendering intent for displaying images
|
the preferences store. [transfer none] |
|
the new rendering intent |
gchar * entangle_preferences_img_get_aspect_ratio
(EntanglePreferences *prefs
);
Get the aspect ratio for any mask to apply to the image
|
the preferences store. [transfer none] |
Returns : |
the aspect ratio for the mask. [transfer full] |
void entangle_preferences_img_set_aspect_ratio (EntanglePreferences *prefs
,const gchar *aspect
);
Set the aspect ratio for any mask to apply to the image
|
the preferences store. [transfer none] |
|
the new aspect ratio |
gint entangle_preferences_img_get_mask_opacity
(EntanglePreferences *prefs
);
Get the opacity of any mask to apply to the image
|
the preferences store. [transfer none] |
Returns : |
the opacity between 0 and 100 |
void entangle_preferences_img_set_mask_opacity (EntanglePreferences *prefs
,gint opacity
);
Set the opacity to use when rendering the image mask
|
the preferences store. [transfer none] |
|
the opacity of the mask between 0 and 100 |
gboolean entangle_preferences_img_get_mask_enabled
(EntanglePreferences *prefs
);
Determine if an aspect ratio mask to be applied to the image display
|
the preferences store. [transfer none] |
Returns : |
TRUE if an aspect ratio mask should be applied |
void entangle_preferences_img_set_mask_enabled (EntanglePreferences *prefs
,gboolean enabled
);
If enabled
is TRUE an aspect ratio mask will be applied
to the image display
|
the preferences store. [transfer none] |
|
TRUE to apply an aspect ratio mask |
gboolean entangle_preferences_img_get_focus_point
(EntanglePreferences *prefs
);
Determine if the center focus point should be displayed in preview mode
|
the preferences store. [transfer none] |
Returns : |
TRUE if a focus point is to be rendered |
void entangle_preferences_img_set_focus_point (EntanglePreferences *prefs
,gboolean enabled
);
If enabled
is TRUE then a focus point will be display in
preview mode.
|
the preferences store. [transfer none] |
|
TRUE to render a focus point |
gint entangle_preferences_img_get_grid_lines
(EntanglePreferences *prefs
);
Determine what grid lines to display in preview mode
|
the preferences store. [transfer none] |
Returns : |
the grid lines to display |
void entangle_preferences_img_set_grid_lines (EntanglePreferences *prefs
,gint gridLines
);
Set the grid lines to display when in image preview mode
|
the preferences store. [transfer none] |
|
the grid lines to display |
gboolean entangle_preferences_img_get_embedded_preview
(EntanglePreferences *prefs
);
Determine whether to use the embedded preview from files for thumbnails.
|
the preferences store. [transfer none] |
Returns : |
TRUE if embedded preview should be used |
void entangle_preferences_img_set_embedded_preview (EntanglePreferences *prefs
,gboolean enabled
);
If enabled
is TRUE, any embedded preview will be used
when generating thumbnails rather than loading the full
resolution image
|
the preferences store. [transfer none] |
|
TRUE to use the embedded preview |
gboolean entangle_preferences_img_get_onion_skin
(EntanglePreferences *prefs
);
Determine if onion skinning should be used when displaying images
|
the preferences store. [transfer none] |
Returns : |
TRUE if onion skinning is enabled |
void entangle_preferences_img_set_onion_skin (EntanglePreferences *prefs
,gboolean enabled
);
If enabled
is TRUE then onion skinning will be enabled
when displaying images
|
the preferences store. [transfer none] |
|
TRUE to enable onion skinning |
gint entangle_preferences_img_get_onion_layers
(EntanglePreferences *prefs
);
Determine how many images to overlay in onion skinning mode
|
the preferences store. [transfer none] |
Returns : |
the number of image overlays |
void entangle_preferences_img_set_onion_layers (EntanglePreferences *prefs
,gint layers
);
Set the number of images to overlay when in onion skinning mode
|
the preferences store. [transfer none] |
|
the number of image overlays |
gchar * entangle_preferences_img_get_background
(EntanglePreferences *prefs
);
Get the colour used as the background when displaying images
|
the preferences store. [transfer none] |
Returns : |
the background colour. [transfer full] |
void entangle_preferences_img_set_background (EntanglePreferences *prefs
,const gchar *bkg
);
Set the colour used as the background when displaying images
|
the preferences store. [transfer none] |
|
the background colour. [transfer none] |
gchar * entangle_preferences_img_get_highlight
(EntanglePreferences *prefs
);
Get the colour to use when highlighting images
|
the preferences store. [transfer none] |
Returns : |
the highlight colour. [transfer full] |
void entangle_preferences_img_set_highlight (EntanglePreferences *prefs
,const gchar *bkg
);
Set the colour to use when highlighting images
|
the preferences store. [transfer none] |
|
the highlight colour. [transfer none] |
"capture-continuous-preview"
property"capture-continuous-preview" gboolean : Read / Write
Continue preview after capturing.
Default value: FALSE
"capture-delete-file"
property"capture-delete-file" gboolean : Read / Write
Delete file after capturing.
Default value: TRUE
"capture-filename-pattern"
property"capture-filename-pattern" gchar* : Read / Write
Pattern for creating new filenames.
Default value: NULL
"capture-last-session"
property"capture-last-session" gchar* : Read / Write
Directory to store pictures in.
Default value: NULL
"capture-sync-clock"
property"capture-sync-clock" gboolean : Read / Write
Synchronize clock automatically.
Default value: FALSE
"cms-detect-system-profile"
property"cms-detect-system-profile" gboolean : Read / Write
Detect the monitor colour profile.
Default value: TRUE
"cms-enabled"
property"cms-enabled" gboolean : Read / Write
Whether to enable colour management on display.
Default value: FALSE
"cms-monitor-profile"
property"cms-monitor-profile" EntangleColourProfile* : Read / Write
Colour profile for monitor.
"cms-rendering-intent"
property"cms-rendering-intent" EntangleColourProfileIntent : Read / Write
Rendering intent for images.
Default value: ENTANGLE_COLOUR_PROFILE_INTENT_PERCEPTUAL
"cms-rgb-profile"
property"cms-rgb-profile" EntangleColourProfile* : Read / Write
Colour profile for workspace.
"img-aspect-ratio"
property"img-aspect-ratio" gchar* : Read / Write
Image mask aspect ratio.
Default value: "1.33"
"img-background"
property"img-background" gchar* : Read / Write
Image background color.
Default value: "#000000"
"img-embedded-preview"
property"img-embedded-preview" gboolean : Read / Write
Embedded preview for raw files.
Default value: FALSE
"img-focus-point"
property"img-focus-point" gboolean : Read / Write
Focus point during preview.
Default value: FALSE
"img-grid-lines"
property"img-grid-lines" gint : Read / Write
Grid lines during preview.
Allowed values: [0,4]
Default value: 4
"img-highlight"
property"img-highlight" gchar* : Read / Write
Image highlight color.
Default value: "#FFFFFF"
"img-mask-enabled"
property"img-mask-enabled" gboolean : Read / Write
Enable aspect ratio image mask.
Default value: FALSE
"img-mask-opacity"
property"img-mask-opacity" gint : Read / Write
Image mask border opacity.
Allowed values: [0,100]
Default value: 90
"img-onion-layers"
property"img-onion-layers" gint : Read / Write
Overlay layers in image display.
Allowed values: [1,5]
Default value: 3
"img-onion-skin"
property"img-onion-skin" gboolean : Read / Write
Enable image overlay display.
Default value: FALSE
"interface-auto-connect"
property"interface-auto-connect" gboolean : Read / Write
Automatically connect to cameras at startup.
Default value: TRUE
"interface-histogram-linear"
property"interface-histogram-linear" gboolean : Read / Write
Use linear histogram.
Default value: FALSE
"interface-screen-blank"
property"interface-screen-blank" gboolean : Read / Write
Blank screen while capturing images.
Default value: FALSE